Manage A10 Networks AX/SoftAX/Thunder/vThunder devices' server object.

Arguments: state, server_ip, server_name, server_ports, partition, validate_certs, server_status

Manage SLB (Server Load Balancer) server objects on A10 Networks devices via aXAPIv2.

Manage A10 Networks AX/SoftAX/Thunder/vThunder devices

Arguments: server_ip, server_name, server_ports, operation, validate_certs, server_status

Manage SLB (Server Load Balancer) server objects on A10 Networks devices via aXAPIv3.

Manage A10 Networks AX/SoftAX/Thunder/vThunder devices' service groups.

Arguments: service_group, service_group_protocol, service_group_method, partition, validate_certs, state, servers

Manage SLB (Server Load Balancing) service-group objects on A10 Networks devices via aXAPIv2.

Manage A10 Networks AX/SoftAX/Thunder/vThunder devices' virtual servers.

Arguments: state, virtual_server_status, virtual_server, validate_certs, virtual_server_ip, partition, virtual_server_ports

Manage SLB (Server Load Balancing) virtual server objects on A10 Networks devices via aXAPIv2.

Manage AAA users (aaa:User)

Arguments: first_name, aaa_user, description, aaa_password_update_required, expires, enabled, clear_password_history, aaa_password, phone, state, last_name, expiration, aaa_password_lifetime, email

Manage AAA users on Cisco ACI fabrics.

Manage AAA user certificates (aaa:UserCert)

Arguments: certificate_name, state, aaa_user, certificate, aaa_user_type

Manage AAA user certificates on Cisco ACI fabrics.

Manage port blocks of Fabric interface policy leaf profile interface selectors (infra:HPortS, infra:PortBlk)

Arguments: from_port, from_card, access_port_selector, leaf_port_blk, to_card, leaf_port_blk_description, to_port, state, leaf_interface_profile

Manage port blocks of Fabric interface policy leaf profile interface selectors on Cisco ACI fabrics.

Manage Fabric interface policy leaf profile interface selectors (infra:HPortS, infra:RsAccBaseGrp, infra:PortBlk)

Arguments: from_port, from_card, description, access_port_selector, interface_type, leaf_port_blk, policy_group, to_card, leaf_port_blk_description, to_port, state, leaf_interface_profile

Manage Fabric interface policy leaf profile interface selectors on Cisco ACI fabrics.

Manage sub port blocks of Fabric interface policy leaf profile interface selectors (infra:HPortS, infra:SubPortBlk)

Arguments: to_sub_port, from_port, from_card, from_sub_port, access_port_selector, leaf_port_blk, to_card, leaf_port_blk_description, to_port, state, leaf_interface_profile

Manage sub port blocks of Fabric interface policy leaf profile interface selectors on Cisco ACI fabrics.

Manage attachable Access Entity Profile (AEP) objects (infra:AttEntityP, infra:ProvAcc)

Arguments: aep, state, infra_vlan, description

Connect to external virtual and physical domains by using attachable Access Entity Profiles (AEP) on Cisco ACI fabrics.

Bind AEPs to Physical or Virtual Domains (infra:RsDomP)

Arguments: domain_type, aep, domain, state, vm_provider

Bind AEPs to Physical or Virtual Domains on Cisco ACI fabrics.

Manage top level Application Profile (AP) objects (fv:Ap)

Arguments: ap, state, description, tenant

Manage top level Application Profile (AP) objects on Cisco ACI fabrics

Manage Bridge Domains (BD) objects (fv:BD)

Arguments: bd, arp_flooding, igmp_snoop_policy, endpoint_retention_action, description, l3_unknown_multicast, enable_routing, vrf, bd_type, ip_learning, tenant, l2_unknown_unicast, endpoint_retention_policy, multi_dest, endpoint_clear, state, ipv6_nd_policy, mac_address, endpoint_move_detect, enable_multicast, limit_ip_learn

Manages Bridge Domains (BD) on Cisco ACI fabrics.

Manage Subnets (fv:Subnet)

Arguments: bd, description, nd_prefix_policy, enable_vip, mask, preferred, subnet_control, state, route_profile, route_profile_l3_out, scope, gateway, tenant, subnet_name

Manage Subnets on Cisco ACI fabrics.

Bind Bridge Domain to L3 Out (fv:RsBDToOut)

Arguments: bd, l3out, state, tenant

Bind Bridge Domain to L3 Out on Cisco ACI fabrics.

Provides rollback and rollback preview functionality (config:ImportP)

Arguments: export_policy, import_mode, description, fail_on_decrypt, compare_export_policy, state, snapshot, import_type, compare_snapshot, import_policy

Provides rollback and rollback preview functionality for Cisco ACI fabrics. Config Rollbacks are done using snapshots C(aci_snapshot) with the configImportP class.

Manage Config Snapshots (config:Snapshot, config:ExportP)

Arguments: include_secure, state, snapshot, description, format, export_policy, max_count

Manage Config Snapshots on Cisco ACI fabrics. Creating new Snapshots is done using the configExportP class. Removing Snapshots is done using the configSnapshot class.

Manage contract resources (vz:BrCP)

Arguments: priority, contract, state, description, scope, dscp, tenant

Manage Contract resources on Cisco ACI fabrics.

Manage initial Contract Subjects (vz:Subj)

Arguments: description, consumer_match, dscp, priority, state, contract, reverse_filter, provider_match, tenant, subject

Manage initial Contract Subjects on Cisco ACI fabrics.

Bind Contract Subjects to Filters (vz:RsSubjFiltAtt)

Arguments: filter, state, log, subject, contract, tenant

Bind Contract Subjects to Filters on Cisco ACI fabrics.

Manage physical, virtual, bridged, routed or FC domain profiles (phys:DomP, vmm:DomP, l2ext:DomP, l3ext:DomP, fc:DomP)

Arguments: domain, dscp, domain_type, state, encap_mode, vswitch, multicast_address, vm_provider

Manage physical, virtual, bridged, routed or FC domain profiles on Cisco ACI fabrics.

Bind Domain to Encap Pools (infra:RsVlanNs)

Arguments: pool_type, domain_type, domain, pool_allocation_mode, vm_provider, state, pool

Bind Domain to Encap Pools on Cisco ACI fabrics.

Bind Domain to VLAN Pools (infra:RsVlanNs)

Arguments: domain_type, domain, pool_allocation_mode, vm_provider, state, pool

Bind Domain to VLAN Pools on Cisco ACI fabrics.

Manage encap pools (fvns:VlanInstP, fvns:VxlanInstP, fvns:VsanInstP)

Arguments: pool_type, state, pool_allocation_mode, description, pool

Manage vlan, vxlan, and vsan pools on Cisco ACI fabrics.

Manage encap ranges assigned to pools (fvns:EncapBlk, fvns:VsanEncapBlk)

Arguments: range_end, range_start, pool_allocation_mode, description, pool_type, state, allocation_mode, pool, range_name

Manage vlan, vxlan, and vsan ranges that are assigned to pools on Cisco ACI fabrics.

Manage End Point Groups (EPG) objects (fv:AEPg)

Arguments: bd, description, fwd_control, priority, ap, state, preferred_group, epg, intra_epg_isolation, tenant

Manage End Point Groups (EPG) on Cisco ACI fabrics.

Manage monitoring policies (mon:EPGPol)

Arguments: monitoring_policy, description, tenant, state

Manage monitoring policies on Cisco ACI fabrics.

Bind EPGs to Contracts (fv:RsCons, fv:RsProv)

Arguments: contract, priority, ap, state, contract_type, epg, provider_match, tenant

Bind EPGs to Contracts on Cisco ACI fabrics.

Bind EPGs to Domains (fv:RsDomAtt)

Arguments: domain, ap, allow_useg, switching_mode, deploy_immediacy, resolution_immediacy, domain_type, primary_encap, state, encap, encap_mode, epg, vm_provider, netflow, tenant

Bind EPGs to Physical and Virtual Domains on Cisco ACI fabrics.

Manage Fabric Node Members (fabric:NodeIdentP)

Arguments: state, node_id, role, description, serial, switch, pod_id

Manage Fabric Node Members on Cisco ACI fabrics.

This modules creates ACI schedulers.

Arguments: name, hour, state, concurCap, windowname, date, maxTime, recurring, day, minute, description

With the module you can create schedule policies that can be a shell, onetime execution or recurring

Manages top level filter objects (vz:Filter)

Arguments: filter, state, description, tenant

Manages top level filter objects on Cisco ACI fabrics. This modules does not manage filter entries, see M(aci_filter_entry) for this functionality.

Manage filter entries (vz:Entry)

Arguments: filter, dst_port_start, dst_port_end, description, icmp6_msg_type, icmp_msg_type, arp_flag, stateful, state, ether_type, dst_port, entry, tenant, ip_protocol

Manage filter entries for a filter on Cisco ACI fabrics.

This module creates a firmware group

Arguments: state, firmwarepol, group

This module creates a firmware group, so that you can apply firmware policy to nodes.

This modules adds and remove nodes from the firmware group

Arguments: node, state, group

This module addes/deletes a node to the firmware group. This modules assigns 1 node at a time.

This creates a firmware policy

Arguments: ignoreCompat, state, version, name

This module creates a firmware policy for firmware groups. The firmware policy is create first and then referenced by the firmware group. You will assign the firmware and specify if you want to ignore the compatibility check

Manage firmware image sources (firmware:OSource)

Arguments: url_password, url_protocol, url_username, source, url, polling_interval, state

Manage firmware image sources on Cisco ACI fabrics.

Manage CDP interface policies (cdp:IfPol)

Arguments: cdp_policy, admin_state, description, state

Manage CDP interface policies on Cisco ACI fabrics.

Manage Fibre Channel interface policies (fc:IfPol)

Arguments: state, fc_policy, port_mode, description

Manage ACI Fiber Channel interface policies on Cisco ACI fabrics.

Manage Layer 2 interface policies (l2:IfPol)

Arguments: state, description, vepa, vlan_scope, l2_policy, qinq

Manage Layer 2 interface policies on Cisco ACI fabrics.

Manage fabric interface policy leaf policy groups (infra:AccBndlGrp, infra:AccPortGrp)

Arguments: stp_interface_policy, description, egress_data_plane_policing_policy, cdp_policy, storm_control_interface_policy, port_channel_policy, mcp_policy, lag_type, monitoring_policy, aep, priority_flow_control_policy, fibre_channel_interface_policy, l2_interface_policy, policy_group, port_security_policy, link_level_policy, state, ingress_data_plane_policing_policy, slow_drain_policy, lldp_policy

Manage fabric interface policy leaf policy groups on Cisco ACI fabrics.

Manage fabric interface policy leaf profiles (infra:AccPortP)

Arguments: state, leaf_interface_profile, description

Manage fabric interface policy leaf profiles on Cisco ACI fabrics.

Manage LLDP interface policies (lldp:IfPol)

Arguments: receive_state, lldp_policy, transmit_state, description, state

Manage LLDP interface policies on Cisco ACI fabrics.

Manage MCP interface policies (mcp:IfPol)

Arguments: state, admin_state, description, mcp

Manage MCP interface policies on Cisco ACI fabrics.

Manage OSPF interface policies (ospf:IfPol)

Arguments: tenant, retransmit_interval, cost, description, controls, priority, state, dead_interval, prefix_suppression, hello_interval, ospf, network_type, transmit_delay

Manage OSPF interface policies on Cisco ACI fabrics.

Manage port channel interface policies (lacp:LagPol)

Arguments: graceful_convergence, description, load_defer, symmetric_hash, suspend_individual, state, mode, min_links, port_channel, fast_select, max_links

Manage port channel interface policies on Cisco ACI fabrics.

Manage port security (l2:PortSecurityPol)

Arguments: port_security, port_security_timeout, max_end_points, description, state

Manage port security on Cisco ACI fabrics.

Bind interface selector profiles to switch policy leaf profiles (infra:RsAccPortP)

Arguments: interface_selector, state, leaf_profile

Bind interface selector profiles to switch policy leaf profiles on Cisco ACI fabrics.

Manage Layer 3 Outside (L3Out) objects (l3ext:Out)

Arguments: domain, description, dscp, l3protocol, l3out, state, route_control, vrf, asn, tenant

Manage Layer 3 Outside (L3Out) on Cisco ACI fabrics.

Manage External Network Instance Profile (ExtEpg) objects (l3extInstP:instP)

Arguments: l3out, state, preferred_group, description, extepg, dscp, tenant

Manage External Network Instance Profile (ExtEpg) objects (l3extInstP:instP)

Manage External Subnet objects (l3extSubnet:extsubnet)

Arguments: description, l3out, state, subnet_name, extepg, scope, tenant, network

Manage External Subnet objects (l3extSubnet:extsubnet)

Manage route tag policies (l3ext:RouteTagPol)

Arguments: state, tag, rtp, tenant, description

Manage route tag policies on Cisco ACI fabrics.

This creates an ACI maintenance group

Arguments: policy, state, group

This modules creates an ACI maintenance group

Manage maintenance group nodes

Arguments: node, state, group

Manage maintenance group nodes

Manage firmware maintenance policies

Arguments: runmode, state, name, scheduler, ignoreCompat, graceful, adminst

Manage maintenance policies that defines behavior during an ACI upgrade.

Direct access to the Cisco APIC REST API

Arguments: content, path, method, src

Enables the management of the Cisco ACI fabric through direct access to the Cisco APIC REST API. Thanks to the idempotent nature of the APIC, this module is idempotent and reports changes.

Bind static paths to EPGs (fv:RsPathAtt)

Arguments: interface_mode, description, interface_type, primary_encap_id, deploy_immediacy, encap_id, ap, state, leafs, interface, epg, pod_id, tenant, extpaths

Bind static paths to EPGs on Cisco ACI fabrics.

Bind leaf selectors to switch policy leaf profiles (infra:LeafS, infra:NodeBlk, infra:RsAccNodePGrep)

Arguments: from, description, leaf_profile, to, state, leaf_node_blk_description, leaf, leaf_node_blk, policy_group

Bind leaf selectors (with node block range and policy group) to switch policy leaf profiles on Cisco ACI fabrics.

Manage switch policy leaf profiles (infra:NodeP)

Arguments: state, description, leaf_profile

Manage switch policy leaf profiles on Cisco ACI fabrics.

Manage switch policy explicit vPC protection groups (fabric:ExplicitGEp, fabric:NodePEp).

Arguments: vpc_domain_policy, state, protection_group, switch_2_id, switch_1_id, protection_group_id

Manage switch policy explicit vPC protection groups on Cisco ACI fabrics.

Manage taboo contracts (vz:BrCP)

Arguments: scope, taboo_contract, description, tenant, state

Manage taboo contracts on Cisco ACI fabrics.

Manage tenants (fv:Tenant)

Arguments: state, description, tenant

Manage tenants on Cisco ACI fabrics.

Manage action rule profiles (rtctrl:AttrP)

Arguments: action_rule, state, description, tenant

Manage action rule profiles on Cisco ACI fabrics.

Manage End Point (EP) retention protocol policies (fv:EpRetPol)

Arguments: description, hold_interval, epr_policy, bounce_trigger, state, local_ep_interval, bounce_age, move_frequency, remote_ep_interval, tenant

Manage End Point (EP) retention protocol policies on Cisco ACI fabrics.

Manage SPAN destination groups (span:DestGrp)

Arguments: state, dst_group, description, tenant

Manage SPAN destination groups on Cisco ACI fabrics.

Manage SPAN source groups (span:SrcGrp)

Arguments: state, admin_state, description, dst_group, tenant, src_group

Manage SPAN source groups on Cisco ACI fabrics.

Bind SPAN source groups to destination groups (span:SpanLbl)

Arguments: state, dst_group, description, tenant, src_group

Bind SPAN source groups to associated destination groups on Cisco ACI fabrics.

Manage VLAN pools (fvns:VlanInstP)

Arguments: state, pool_allocation_mode, description, pool

Manage VLAN pools on Cisco ACI fabrics.

Manage encap blocks assigned to VLAN pools (fvns:EncapBlk)

Arguments: pool_allocation_mode, block_end, description, block_start, block_name, state, allocation_mode, pool

Manage VLAN encap blocks that are assigned to VLAN pools on Cisco ACI fabrics.

Manage virtual domain credential profiles (vmm:UsrAccP)

Arguments: domain, name, credential_username, vm_provider, state, credential_password, description

Manage virtual domain credential profiles on Cisco ACI fabrics.

Manage contexts or VRFs (fv:Ctx)

Arguments: tenant, state, policy_control_preference, description, policy_control_direction, vrf

Manage contexts or VRFs on Cisco ACI fabrics. Each context is a private network associated to a tenant, i.e. VRF.

Set and retrieve file ACL information.

Arguments: recursive, default, recalculate_mask, entity, state, follow, etype, entry, path, permissions, use_nfsv4_acls

Set and retrieve file ACL information.

Create, modify or delete ACME accounts

Arguments: state, contact, terms_agreed, new_account_key_content, new_account_key_src, allow_creation

Allows to create, modify or delete accounts with a CA supporting the L(ACME protocol,https://tools.ietf.org/html/rfc8555), such as L(Let's Encrypt,https://letsencrypt.org/). This module only works with the ACME v2 protocol.

Retrieves information on ACME accounts

Arguments: retrieve_orders

Allows to retrieve information on accounts a CA supporting the L(ACME protocol,https://tools.ietf.org/html/rfc8555), such as L(Let's Encrypt,https://letsencrypt.org/). This module only works with the ACME v2 protocol.

Create SSL/TLS certificates with the ACME protocol

Arguments: force, account_email, dest, remaining_days, challenge, fullchain_dest, modify_account, agreement, data, retrieve_all_alternates, terms_agreed, csr, chain_dest, deactivate_authzs

Create and renew SSL/TLS certificates with a CA supporting the L(ACME protocol,https://tools.ietf.org/html/rfc8555), such as L(Let's Encrypt,https://letsencrypt.org/) or L(Buypass,https://www.buypass.com/). The current implementation supports the C(http-01), C(dns-01) and C(tls-alpn-01) challenges. To use this module, it has to be executed twice. Either as two different tasks in the same run or during two runs. Note that the output of the first run needs to be recorded and passed to the second run as the module argument C(data). Between these two tasks you have to fulfill the required steps for the chosen challenge by whatever means necessary. For C(http-01) that means creating the necessary challenge file on the destination webserver. For C(dns-01) the necessary dns record has to be created. For C(tls-alpn-01) the necessary certificate has to be created and served. It is I(not) the responsibility of this module to perform these steps. For details on how to fulfill these challenges, you might have to read through L(the main ACME specification,https://tools.ietf.org/html/rfc8555#section-8) and the L(TLS-ALPN-01 specification,https://www.rfc-editor.org/rfc/rfc8737.html#section-3). Also, consider the examples provided for this module. The module includes experimental support for IP identifiers according to the L(RFC 8738,https://www.rfc-editor.org/rfc/rfc8738.html).

Revoke certificates with the ACME protocol

Arguments: private_key_content, private_key_src, account_key_content, certificate, revoke_reason, account_key_src

Allows to revoke certificates issued by a CA supporting the L(ACME protocol,https://tools.ietf.org/html/rfc8555), such as L(Let's Encrypt,https://letsencrypt.org/).

Prepare certificates required for ACME challenges such as C(tls-alpn-01)

Arguments: challenge_data, private_key_src, challenge, private_key_content

Prepares certificates for ACME challenges such as C(tls-alpn-01). The raw data is provided by the M(acme_certificate) module, and needs to be converted to a certificate to be used for challenge validation. This module provides a simple way to generate the required certificates.

Send direct requests to an ACME server

Arguments: url, content, fail_on_acme_error, method

Allows to send direct requests to an ACME server with the L(ACME protocol,https://tools.ietf.org/html/rfc8555), which is supported by CAs such as L(Let's Encrypt,https://letsencrypt.org/). This module can be used to debug failed certificate request attempts, for example when M(acme_certificate) fails or encounters a problem which you wish to investigate. The module can also be used to directly access features of an ACME servers which are not yet supported by the Ansible ACME modules.

Add a host (and alternatively a group) to the ansible-playbook in-memory inventory

Arguments: name, groups

Use variables to create new hosts and groups in inventory for use in later plays of the same playbook. Takes variables so you can define the new hosts more fully. This module is also supported for Windows targets.

Check or wait for migrations between nodes

Arguments: tries_limit, consecutive_good_checks, local_only, min_cluster_size, migrate_tx_key, port, host, target_cluster_size, fail_on_cluster_change, sleep_between_checks, connect_timeout, migrate_rx_key

This can be used to check for migrations in a cluster. This makes it easy to do a rolling upgrade/update on Aerospike nodes. If waiting for migrations is not desired, simply just poll until port 3000 if available or asinfo -v status returns ok

Notify airbrake about app deployments

Arguments: repo, environment, token, user, url, validate_certs, revision

Notify airbrake about app deployments (see http://help.airbrake.io/kb/api-2/deploy-tracking)

Run commands on remote devices running Cisco WLC

Arguments: retries, commands, wait_for, match, interval

Sends arbitrary commands to an aireos node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met. Commands run in configuration mode with this module are not idempotent. Please use M(aireos_config) to configure WLC devices.

Manage Cisco WLC configurations

Arguments: src, backup_options, after, lines, diff_against, intended_config, running_config, save, before, save_when, backup, match, diff_ignore_lines

AireOS does not use a block indent file syntax, so there are no sections or parents. This module provides an implementation for working with AireOS configurations in a deterministic way.

Manages AIX devices

Arguments: device, attributes, state, force, recursive

This module discovers, defines, removes and modifies attributes of AIX devices.

Configure LVM and NFS file systems for AIX

Arguments: vg, account_subsystem, auto_mount, mount_group, state, fs_type, rm_mount_point, filesystem, device, attributes, permissions, nfs_server, size

This module creates, removes, mount and unmount LVM and NFS file system for AIX using C(/etc/filesystems). For LVM file systems is possible to resize a file system.

Manages the inittab on AIX

Arguments: action, state, command, name, runlevel, insertafter

Manages the inittab on AIX.

Manage LVM volume groups on AIX

Arguments: pvs, force, vg, pp_size, state, vg_type

This module creates, removes or resize volume groups on AIX LVM.

Configure AIX LVM logical volumes

Arguments: pvs, lv_type, vg, copies, lv, state, policy, opts, size

This module creates, removes or resizes AIX logical volumes. Inspired by lvol module.

Create, Start, Stop, Restart or Terminate an Instance in ECS. Add or Remove Instance to/from a Security Group.

Arguments: max_bandwidth_in, force, auto_renew, availability_zone, key_name, system_disk_size, period, instance_ids, user_data, image_id, auto_renew_period, system_disk_description, password, security_groups, internet_charge_type, count, allocate_public_ip, instance_type, vswitch_id, description, max_bandwidth_out, instance_name, system_disk_name, state, host_name, count_tag, instance_tags, instance_charge_type, system_disk_category

Create, start, stop, restart, modify or terminate ecs instances. Add or remove ecs instances to/from security group.

Gather information on instances of Alibaba Cloud ECS.

Arguments: instance_names, instance_tags, instance_ids, availability_zone

This module fetches data from the Open API in Alicloud. The module must be called from within the ECS instance itself. This module was called C(ali_instance_facts) before Ansible 2.9. The usage did not change.

Manages alternative programs for common commands

Arguments: priority, path, link, name

Manages symbolic links using the 'update-alternatives' tool. Useful when multiple programs are installed but provide similar functionality (e.g. different editors).

Set and/or get members' attributes of an Apache httpd 2.4 mod_proxy balancer pool

Arguments: tls, balancer_vhost, member_host, validate_certs, state, balancer_url_suffix

Set and/or get members' attributes of an Apache httpd 2.4 mod_proxy balancer pool, using HTTP POST and GET requests. The httpd mod_proxy balancer-member status page has to be enabled and accessible, as this module relies on parsing this page. This module supports ansible check_mode, and requires BeautifulSoup python module.

Enables/disables a module of the Apache2 webserver.

Arguments: state, identifier, force, name, ignore_configcheck

Enables or disables a specified module of the Apache2 webserver.

Manages apk packages

Arguments: available, state, upgrade, update_cache, name, repository

Manages I(apk) packages for Alpine Linux.

Manages apt-packages

Arguments: autoremove, force, force_apt_get, update_cache, only_upgrade, deb, cache_valid_time, dpkg_options, upgrade, name, policy_rc_d, autoclean, purge, allow_unauthenticated, state, default_release, install_recommends

Manages I(apt) packages (such as for Debian/Ubuntu).

Add or remove an apt key

Arguments: keyserver, url, data, keyring, state, file, validate_certs, id

Add or remove an I(apt) key, optionally downloading it.

Manage APT repositories via apt-repo

Arguments: repo, state, remove_others, update

Manages APT repositories using apt-repo tool. See U(https://www.altlinux.org/Apt-repo) for details about apt-repo

Add and remove APT repositories

Arguments: repo, state, update_cache, mode, codename, validate_certs, filename

Add or remove an APT repositories in Ubuntu and Debian.

apt_rpm package manager

Arguments: state, update_cache, pkg

Manages packages with I(apt-rpm). Both low-level (I(rpm)) and high-level (I(apt-get)) package manager binaries required.

Creates a compressed archive of one or more files or trees

Arguments: force_archive, exclude_path, format, dest, path, remove

Packs an archive. It is the opposite of M(unarchive). By default, it assumes the compression source exists on the target. It will not copy the source file from the local system to the target before archiving. Source files can be deleted after archival by specifying I(remove=True).

Run commands on remote devices running Aruba Mobility Controller

Arguments: retries, commands, wait_for, match, interval

Sends arbitrary commands to an aruba node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met. This module does not support running commands in configuration mode. Please use M(aruba_config) to configure Aruba devices.

Manage Aruba configuration sections

Arguments: src, backup_options, encrypt, after, lines, intended_config, diff_against, parents, save_when, before, running_config, replace, backup, match, diff_ignore_lines

Aruba configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with Aruba configuration sections in a deterministic way.

Manage access-lists on a Cisco ASA

Arguments: force, before, config, after, lines, match, replace

This module allows you to work with access-lists on a Cisco ASA device.

Run arbitrary commands on Cisco ASA devices

Arguments: retries, commands, wait_for, match, interval

Sends arbitrary commands to an ASA node and returns the results read from the device. The C(asa_command) module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met.

Manage configuration sections on Cisco ASA devices

Arguments: src, passwords, backup, after, lines, replace, backup_options, parents, defaults, save, config, match, before

Cisco ASA configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with ASA configuration sections in a deterministic way.

Manage object groups on a Cisco ASA

Arguments: protocol, description, name, ip_mask, host_ip, group_object, port_range, state, port_eq, group_type, service_cfg

This module allows you to create and update object-group network/service on Cisco ASA device.

Assemble configuration files from fragments

Arguments: ignore_hidden, src, remote_src, dest, delimiter, regexp, validate, backup

Assembles a configuration file from fragments. Often a particular program will take a single configuration file and does not support a C(conf.d) style structure where it is easy to build up the configuration from multiple sources. C(assemble) will take a directory of files that can be local or have already been transferred to the system, and concatenate them together to produce a destination file. Files are assembled in string sorting order. Puppet calls this idea I(fragments).

Asserts given expressions are true

Arguments: fail_msg, success_msg, quiet, that

This module asserts that given expressions are true with an optional custom message. This module is also supported for Windows targets.

Obtain status of asynchronous task

Arguments: jid, mode

This module gets the status of an asynchronous task. This module is also supported for Windows targets.

Manage Layer-3 interfaces on Lenovo CNOS network devices.

Arguments: state, name, ipv6, aggregate, provider, ipv4

Removed keyword

Schedule the execution of a command or script file via the at command

Arguments: count, state, command, units, unique, script_file

Use this module to schedule a command or script file to run once in the future. All jobs are executed in the 'a' queue.

Manage the containers on the atomic host platform

Arguments: state, values, name, rootfs, image, backend, mode

Manage the containers on the atomic host platform Allows to manage the lifecycle of a container on the atomic host platform

Manage the atomic host platform

Arguments: revision

Manage the atomic host platform. Rebooting of Atomic host platform should be done outside this module.

Manage the container images on the atomic host platform

Arguments: started, state, name, backend

Manage the container images on the atomic host platform. Allows to execute the commands specified by the RUN label in the container image when present.

Adds or removes an SSH authorized key

Arguments: comment, exclusive, key_options, state, user, key, path, follow, validate_certs, manage_dir

Adds or removes SSH authorized keys for particular user accounts.

Module for setup of ActionGroupConfig Avi RESTful Object

Arguments: snmp_trap_profile_ref, uuid, name, level, url, syslog_config_ref, tenant_ref, state, action_script_config_ref, autoscale_trigger_notification, avi_api_patch_op, external_only, email_config_ref, avi_api_update_method, description

This module is used to configure ActionGroupConfig object more examples at U(https://github.com/avinetworks/devops)

Module for setup of AlertConfig Avi RESTful Object

Arguments: description, tenant_ref, object_type, autoscale_alert, obj_uuid, recommendation, threshold, throttle, avi_api_update_method, name, category, expiry_time, uuid, url, enabled, avi_api_patch_op, summary, rolling_window, source, state, alert_rule, action_group_ref

This module is used to configure AlertConfig object more examples at U(https://github.com/avinetworks/devops)

Module for setup of AlertEmailConfig Avi RESTful Object

Arguments: to_emails, uuid, url, description, cc_emails, tenant_ref, state, avi_api_patch_op, avi_api_update_method, name

This module is used to configure AlertEmailConfig object more examples at U(https://github.com/avinetworks/devops)

Module for setup of AlertScriptConfig Avi RESTful Object

Arguments: action_script, uuid, url, tenant_ref, state, avi_api_patch_op, avi_api_update_method, name

This module is used to configure AlertScriptConfig object more examples at U(https://github.com/avinetworks/devops)

Module for setup of AlertSyslogConfig Avi RESTful Object

Arguments: syslog_servers, uuid, url, description, tenant_ref, state, avi_api_patch_op, avi_api_update_method, name

This module is used to configure AlertSyslogConfig object more examples at U(https://github.com/avinetworks/devops)

Module for setup of AnalyticsProfile Avi RESTful Object

Arguments: disable_se_analytics, apdex_server_rtt_tolerated_factor, hs_security_tls12_score, exclude_no_dns_record_as_error, conn_server_lossy_zero_win_size_event_threshold, conn_lossy_total_rexmt_threshold, healthscore_max_server_limit, hs_pscore_traffic_threshold_l4_client, exclude_no_valid_gs_member_as_error, enable_advanced_analytics, hs_security_cipherscore_ge128b, uuid, exclude_invalid_dns_domain_as_error, exclude_http_error_codes, hs_max_anomaly_penalty, avi_api_patch_op, sip_log_depth, exclude_persistence_change_as_error, conn_server_lossy_ooo_threshold, hs_security_selfsignedcert_penalty, conn_server_lossy_total_rexmt_threshold, exclude_unsupported_dns_query_as_error, exclude_syn_retransmit_as_error, hs_security_hsts_penalty, apdex_rum_threshold, avi_api_update_method, conn_lossy_zero_win_size_event_threshold, hs_security_encalgo_score_rc4, name, apdex_rtt_threshold, disable_vs_analytics, tenant_ref, apdex_response_tolerated_factor, exclude_tcp_reset_as_error, hs_security_chain_invalidity_penalty, exclude_invalid_dns_query_as_error, conn_lossy_ooo_threshold, hs_security_cipherscore_lt128b, hs_security_encalgo_score_none, hs_event_throttle_window, apdex_rtt_tolerated_factor, hs_security_nonpfs_penalty, hs_security_certscore_gt30d, exclude_server_tcp_reset_as_error, hs_min_dos_rate, hs_max_resources_penalty, client_log_streaming_config, disable_ondemand_metrics, exclude_sip_error_codes, apdex_server_response_threshold, hs_performance_boost, client_log_config, exclude_gs_down_as_error, apdex_server_response_tolerated_factor, state, disable_server_analytics, conn_server_lossy_timeo_rexmt_threshold, exclude_client_close_before_request_as_error, hs_security_weak_signature_algo_penalty, conn_lossy_timeo_rexmt_threshold, ondemand_metrics_idle_timeout, hs_security_certscore_le30d, description, hs_security_ssl30_score, apdex_rum_tolerated_factor, hs_security_cipherscore_eq000b, ranges, apdex_server_rtt_threshold, exclude_server_dns_error_as_error, hs_security_tls11_score, resp_code_block, hs_security_certscore_le07d, hs_pscore_traffic_threshold_l4_server, hs_max_security_penalty, sensitive_log_profile, exclude_dns_policy_drop_as_significant, url, hs_security_tls10_score, hs_security_certscore_expired, apdex_response_threshold

This module is used to configure AnalyticsProfile object more examples at U(https://github.com/avinetworks/devops)

Avi API Module

Arguments: data, http_method, params, timeout, path

This module can be used for calling any resources defined in Avi REST API. U(https://avinetworks.com/) This module is useful for invoking HTTP Patch methods and accessing resources that do not have an REST object associated with them.

Avi API Version Module

Arguments:

This module can be used to obtain the version of the Avi REST API. U(https://avinetworks.com/)

Module for setup of ApplicationPersistenceProfile Avi RESTful Object

Arguments: uuid, app_cookie_persistence_profile, state, persistence_type, name, tenant_ref, is_federated, server_hm_down_recovery, http_cookie_persistence_profile, url, avi_api_patch_op, ip_persistence_profile, hdr_persistence_profile, avi_api_update_method, description

This module is used to configure ApplicationPersistenceProfile object more examples at U(https://github.com/avinetworks/devops)

Module for setup of ApplicationProfile Avi RESTful Object

Arguments: description, state, http_profile, preserve_client_port, dos_rl_profile, preserve_client_ip, avi_api_update_method, name, tcp_app_profile, uuid, dns_service_profile, tenant_ref, sip_service_profile, created_by, url, avi_api_patch_op, cloud_config_cksum, type

This module is used to configure ApplicationProfile object more examples at U(https://github.com/avinetworks/devops)

Module for setup of AuthProfile Avi RESTful Object

Arguments: pa_agent_ref, http, uuid, saml, url, tenant_ref, state, name, avi_api_patch_op, tacacs_plus, ldap, type, avi_api_update_method, description

This module is used to configure AuthProfile object more examples at U(https://github.com/avinetworks/devops)

Module for setup of AutoScaleLaunchConfig Avi RESTful Object

Arguments: uuid, mesos, url, tenant_ref, state, name, image_id, avi_api_patch_op, use_external_asg, openstack, avi_api_update_method, description

This module is used to configure AutoScaleLaunchConfig object more examples at U(https://github.com/avinetworks/devops)

Module for setup of Backup Avi RESTful Object

Arguments: scheduler_ref, uuid, local_file_url, url, file_name, remote_file_url, tenant_ref, state, backup_config_ref, avi_api_patch_op, timestamp, avi_api_update_method

This module is used to configure Backup object more examples at U(https://github.com/avinetworks/devops)

Module for setup of BackupConfiguration Avi RESTful Object

Arguments: avi_api_update_method, aws_bucket_id, remote_directory, remote_hostname, backup_passphrase, aws_secret_access, upload_to_s3, ssh_user_ref, name, aws_access_key, uuid, url, tenant_ref, state, avi_api_patch_op, save_local, maximum_backups_stored, upload_to_remote_host, backup_file_prefix

This module is used to configure BackupConfiguration object more examples at U(https://github.com/avinetworks/devops)

Module for setup of CertificateManagementProfile Avi RESTful Object

Arguments: name, url, tenant_ref, state, avi_api_patch_op, script_path, script_params, avi_api_update_method, uuid

This module is used to configure CertificateManagementProfile object more examples at U(https://github.com/avinetworks/devops)

Module for setup of Cloud Avi RESTful Object

Arguments: vca_configuration, proxy_configuration, docker_configuration, oshiftk8s_configuration, autoscale_polling_interval, dhcp_enabled, rancher_configuration, vtype, uuid, linuxserver_configuration, custom_tags, state, gcp_configuration, nsx_configuration, avi_api_patch_op, apic_mode, dns_provider_ref, mesos_configuration, ip6_autocfg_enabled, openstack_configuration, enable_vip_static_routes, east_west_dns_provider_ref, ipam_provider_ref, cloudstack_configuration, avi_api_update_method, name, azure_configuration, license_tier, state_based_dns_registration, url, tenant_ref, mtu, east_west_ipam_provider_ref, obj_name_prefix, apic_configuration, prefer_static_routes, license_type, vcenter_configuration, aws_configuration

This module is used to configure Cloud object more examples at U(https://github.com/avinetworks/devops)

Module for setup of CloudConnectorUser Avi RESTful Object

Arguments: public_key, private_key, azure_serviceprincipal, name, url, tenant_ref, state, gcp_credentials, avi_api_patch_op, oci_credentials, azure_userpass, tencent_credentials, avi_api_update_method, uuid

This module is used to configure CloudConnectorUser object more examples at U(https://github.com/avinetworks/devops)

Module for setup of CloudProperties Avi RESTful Object

Arguments: info, hyp_props, uuid, url, state, avi_api_patch_op, cc_props, cc_vtypes, avi_api_update_method

This module is used to configure CloudProperties object more examples at U(https://github.com/avinetworks/devops)

Module for setup of Cluster Avi RESTful Object

Arguments: uuid, name, url, tenant_ref, state, avi_api_patch_op, virtual_ip, nodes, avi_api_update_method, rejoin_nodes_automatically

This module is used to configure Cluster object more examples at U(https://github.com/avinetworks/devops)

Module for setup of ClusterCloudDetails Avi RESTful Object

Arguments: name, url, tenant_ref, state, avi_api_patch_op, azure_info, avi_api_update_method, uuid

This module is used to configure ClusterCloudDetails object more examples at U(https://github.com/avinetworks/devops)

Module for setup of ControllerProperties Avi RESTful Object

Arguments: vs_se_ping_fail, portal_token, cluster_ip_gratuitous_arp_period, persistence_key_rotate_period, bm_use_ansible, attach_ip_retry_interval, vs_se_vnic_fail, secure_channel_se_token_timeout, attach_ip_retry_limit, se_vnic_cooldown, vnic_op_fail_time, max_pcap_per_tenant, enable_memory_balancer, vs_se_bootup_fail, seupgrade_fabric_pool_size, cleanup_expired_authtoken_timeout_period, vs_key_rotate_period, seupgrade_segroup_min_dead_timeout, dns_refresh_period, max_dead_se_in_grp, upgrade_lease_time, warmstart_vs_resync_wait_time, avi_api_patch_op, se_create_timeout, query_host_fail, vs_apic_scaleout_timeout, unresponsive_se_reboot, state, process_pki_profile_timeout_period, se_offline_del, allow_ip_forwarding, upgrade_dns_ttl, fatal_error_lease_time, api_perf_logging_threshold, vs_se_attach_ip_fail, api_idle_timeout, max_seq_vnic_failures, allow_unauthenticated_nodes, allow_unauthenticated_apis, vs_scaleout_ready_check_interval, safenet_hsm_version, se_from_marketplace, warmstart_se_reconnect_wait_time, process_locked_useraccounts_timeout_period, consistency_check_timeout_period, avi_api_update_method, uuid, dummy, max_seq_attach_ip_failures, cleanup_sessions_timeout_period, secure_channel_cleanup_timeout, ssl_certificate_expiry_warning_days, vs_se_vnic_ip_fail, secure_channel_controller_token_timeout, url, vs_se_create_fail, cloud_reconcile, crashed_se_reboot, appviewx_compat_mode, vs_awaiting_se_timeout, enable_api_sharding, se_failover_attempt_interval, dead_se_detection_timer

This module is used to configure ControllerProperties object more examples at U(https://github.com/avinetworks/devops)

Module for setup of CustomIpamDnsProfile Avi RESTful Object

Arguments: name, url, tenant_ref, state, script_uri, avi_api_patch_op, script_params, avi_api_update_method, uuid

This module is used to configure CustomIpamDnsProfile object more examples at U(https://github.com/avinetworks/devops)

Module for setup of DnsPolicy Avi RESTful Object

Arguments: uuid, url, description, tenant_ref, state, created_by, avi_api_patch_op, rule, avi_api_update_method, name

This module is used to configure DnsPolicy object more examples at U(https://github.com/avinetworks/devops)

Module for setup of ErrorPageBody Avi RESTful Object

Arguments: name, format, url, tenant_ref, state, error_page_body, avi_api_patch_op, avi_api_update_method, uuid

This module is used to configure ErrorPageBody object more examples at U(https://github.com/avinetworks/devops)

Module for setup of ErrorPageProfile Avi RESTful Object

Arguments: uuid, error_pages, tenant_ref, state, name, url, avi_api_patch_op, company_name, host_name, avi_api_update_method, app_name

This module is used to configure ErrorPageProfile object more examples at U(https://github.com/avinetworks/devops)

Module for setup of Gslb Avi RESTful Object

Arguments: description, state, maintenance_mode, view_id, sites, dns_configs, leader_cluster_uuid, async_interval, send_interval_prior_to_maintenance_mode, name, uuid, url, tenant_ref, is_federated, clear_on_max_retries, avi_api_patch_op, send_interval, avi_api_update_method, client_ip_addr_group, third_party_sites

This module is used to configure Gslb object more examples at U(https://github.com/avinetworks/devops)

Module for setup of GslbGeoDbProfile Avi RESTful Object

Arguments: uuid, state, url, tenant_ref, is_federated, name, avi_api_patch_op, entries, avi_api_update_method, description

This module is used to configure GslbGeoDbProfile object more examples at U(https://github.com/avinetworks/devops)

Module for setup of GslbService Avi RESTful Object

Arguments: hm_off, description, wildcard_match, application_persistence_profile_ref, enabled, domain_names, is_federated, use_edns_client_subnet, groups, ttl, health_monitor_scope, avi_api_update_method, name, controller_health_status_enabled, uuid, url, down_response, tenant_ref, avi_api_patch_op, created_by, health_monitor_refs, state, site_persistence_enabled, min_members, pool_algorithm, num_dns_ip

This module is used to configure GslbService object more examples at U(https://github.com/avinetworks/devops)

Avi API Module

Arguments: data, state, params, name

This module can be used for calling any resources defined in Avi REST API. U(https://avinetworks.com/) This module is useful for invoking HTTP Patch methods and accessing resources that do not have an REST object associated with them.

Module for setup of HardwareSecurityModuleGroup Avi RESTful Object

Arguments: name, url, tenant_ref, state, hsm, avi_api_patch_op, avi_api_update_method, uuid

This module is used to configure HardwareSecurityModuleGroup object more examples at U(https://github.com/avinetworks/devops)

Module for setup of HealthMonitor Avi RESTful Object

Arguments: https_monitor, receive_timeout, description, radius_monitor, is_federated, udp_monitor, http_monitor, avi_api_update_method, successful_checks, monitor_port, sip_monitor, uuid, url, dns_monitor, tenant_ref, avi_api_patch_op, name, failed_checks, tcp_monitor, state, send_interval, external_monitor, type

This module is used to configure HealthMonitor object more examples at U(https://github.com/avinetworks/devops)

Module for setup of HTTPPolicySet Avi RESTful Object

Arguments: is_internal_policy, uuid, url, tenant_ref, state, created_by, name, avi_api_patch_op, cloud_config_cksum, http_security_policy, http_request_policy, http_response_policy, avi_api_update_method, description

This module is used to configure HTTPPolicySet object more examples at U(https://github.com/avinetworks/devops)

Module for setup of IpAddrGroup Avi RESTful Object

Arguments: description, marathon_service_port, ranges, addrs, avi_api_update_method, uuid, country_codes, name, url, tenant_ref, state, apic_epg_name, prefixes, avi_api_patch_op, marathon_app_name, ip_ports

This module is used to configure IpAddrGroup object more examples at U(https://github.com/avinetworks/devops)

Module for setup of IpamDnsProviderProfile Avi RESTful Object

Arguments: state, proxy_configuration, infoblox_profile, allocate_ip_in_vrf, oci_profile, internal_profile, aws_profile, tencent_profile, avi_api_update_method, uuid, azure_profile, openstack_profile, name, gcp_profile, url, tenant_ref, custom_profile, avi_api_patch_op, type

This module is used to configure IpamDnsProviderProfile object more examples at U(https://github.com/avinetworks/devops)

Module for setup of L4PolicySet Avi RESTful Object

Arguments: l4_connection_policy, uuid, url, tenant_ref, state, created_by, name, avi_api_patch_op, is_internal_policy, avi_api_update_method, description

This module is used to configure L4PolicySet object more examples at U(https://github.com/avinetworks/devops)

Module for setup of MicroServiceGroup Avi RESTful Object

Arguments: uuid, url, description, tenant_ref, state, created_by, avi_api_patch_op, service_refs, avi_api_update_method, name

This module is used to configure MicroServiceGroup object more examples at U(https://github.com/avinetworks/devops)

Module for setup of Network Avi RESTful Object

Arguments: exclude_discovered_subnets, ip6_autocfg_enabled, vrf_context_ref, vcenter_dvs, uuid, configured_subnets, name, vimgrnw_ref, cloud_ref, tenant_ref, state, synced_from_se, dhcp_enabled, url, avi_api_patch_op, avi_api_update_method

This module is used to configure Network object more examples at U(https://github.com/avinetworks/devops)

Module for setup of NetworkProfile Avi RESTful Object

Arguments: profile, uuid, url, description, tenant_ref, state, avi_api_patch_op, connection_mirror, avi_api_update_method, name

This module is used to configure NetworkProfile object more examples at U(https://github.com/avinetworks/devops)

Module for setup of NetworkSecurityPolicy Avi RESTful Object

Arguments: uuid, rules, tenant_ref, state, created_by, name, url, avi_api_patch_op, cloud_config_cksum, avi_api_update_method, description

This module is used to configure NetworkSecurityPolicy object more examples at U(https://github.com/avinetworks/devops)

Module for setup of PKIProfile Avi RESTful Object

Arguments: crls, name, state, url, ignore_peer_chain, tenant_ref, is_federated, created_by, ca_certs, avi_api_patch_op, validate_only_leaf_crl, crl_check, avi_api_update_method, uuid

This module is used to configure PKIProfile object more examples at U(https://github.com/avinetworks/devops)

Module for setup of Pool Avi RESTful Object

Arguments: host_check_enabled, delete_server_on_dns_refresh, capacity_estimation, servers, capacity_estimation_ttfb_thresh, fewest_tasks_feedback_delay, server_auto_scale, ipaddrgroup_ref, lookup_server_by_name, networks, lb_algorithm_hash, analytics_profile_ref, uuid, server_name, autoscale_policy_ref, ssl_profile_ref, created_by, apic_epg_name, application_persistence_profile_ref, inline_health_monitor, request_queue_depth, server_reselect, ab_priority, ssl_key_and_certificate_ref, avi_api_update_method, name, autoscale_launch_config_ref, tenant_ref, autoscale_networks, health_monitor_refs, min_health_monitors_up, external_autoscale_groups, vrf_ref, gslb_sp_enabled, lb_algorithm, use_service_port, rewrite_host_header_to_server_name, lb_algorithm_core_nonaffinity, conn_pool_properties, rewrite_host_header_to_sni, max_conn_rate_per_server, ab_pool, min_servers_up, fail_action, service_metadata, sni_enabled, cloud_ref, domain_name, east_west, placement_networks, graceful_disable_timeout, state, nsx_securitygroup, a_pool, pki_profile_ref, analytics_policy, default_server_port, description, enabled, avi_api_patch_op, server_timeout, request_queue_enabled, max_concurrent_connections_per_server, url, prst_hdr_name, server_count, lb_algorithm_consistent_hash_hdr, connection_ramp_duration, cloud_config_cksum

This module is used to configure Pool object more examples at U(https://github.com/avinetworks/devops)

Module for setup of PoolGroup Avi RESTful Object

Arguments: description, implicit_priority_labels, members, fail_action, service_metadata, avi_api_update_method, name, priority_labels_ref, uuid, cloud_ref, tenant_ref, state, created_by, url, avi_api_patch_op, cloud_config_cksum, min_servers, deployment_policy_ref

This module is used to configure PoolGroup object more examples at U(https://github.com/avinetworks/devops)

Module for setup of PoolGroupDeploymentPolicy Avi RESTful Object

Arguments: target_test_traffic_ratio, evaluation_duration, description, test_traffic_ratio_rampup, rules, auto_disable_old_prod_pools, tenant_ref, state, name, url, avi_api_patch_op, webhook_ref, scheme, avi_api_update_method, uuid

This module is used to configure PoolGroupDeploymentPolicy object more examples at U(https://github.com/avinetworks/devops)

Module for setup of PriorityLabels Avi RESTful Object

Arguments: uuid, cloud_ref, tenant_ref, state, name, url, avi_api_patch_op, equivalent_labels, avi_api_update_method, description

This module is used to configure PriorityLabels object more examples at U(https://github.com/avinetworks/devops)

Module for setup of Role Avi RESTful Object

Arguments: name, url, privileges, tenant_ref, state, avi_api_patch_op, avi_api_update_method, uuid

This module is used to configure Role object more examples at U(https://github.com/avinetworks/devops)

Module for setup of Scheduler Avi RESTful Object

Arguments: state, enabled, backup_config_ref, frequency, scheduler_action, end_date_time, avi_api_update_method, uuid, start_date_time, name, url, tenant_ref, frequency_unit, avi_api_patch_op, run_script_ref, run_mode

This module is used to configure Scheduler object more examples at U(https://github.com/avinetworks/devops)

Module for setup of SeProperties Avi RESTful Object

Arguments: se_agent_properties, uuid, url, se_runtime_properties, state, avi_api_patch_op, se_bootup_properties, avi_api_update_method

This module is used to configure SeProperties object more examples at U(https://github.com/avinetworks/devops)

Module for setup of ServerAutoScalePolicy Avi RESTful Object

Arguments: use_predicted_load, intelligent_autoscale, description, intelligent_scaleout_margin, scaleout_alertconfig_refs, min_size, scalein_cooldown, scaleout_cooldown, max_size, name, intelligent_scalein_margin, uuid, url, tenant_ref, state, max_scalein_adjustment_step, avi_api_patch_op, scalein_alertconfig_refs, avi_api_update_method, max_scaleout_adjustment_step

This module is used to configure ServerAutoScalePolicy object more examples at U(https://github.com/avinetworks/devops)

Module for setup of ServiceEngine Avi RESTful Object

Arguments: enable_state, mgmt_vnic, tenant_ref, controller_created, flavor, avi_api_update_method, uuid, name, cloud_ref, hypervisor, se_group_ref, container_mode, data_vnics, state, container_type, host_ref, url, avi_api_patch_op, availability_zone, controller_ip, resources

This module is used to configure ServiceEngine object more examples at U(https://github.com/avinetworks/devops)

Module for setup of ServiceEngineGroup Avi RESTful Object

Arguments: disable_tso, host_attribute_value, async_ssl, instance_flavor, auto_redistribute_active_standby_load, disable_avi_securitygroups, self_se_election, free_list_size, bgp_state_update_interval, uuid, vs_scalein_timeout, se_udp_encap_ipc, min_cpu_usage, custom_securitygroups_data, ingress_access_data, vcenter_clusters, max_rules_per_lb, iptables, num_dispatcher_cores, connection_memory_percentage, service_ip_subnets, placement_mode, max_scaleout_per_vs, enable_routing, waf_mempool, per_app, se_pcap_lookahead, vcenter_datastores_include, se_name_prefix, waf_learning_memory, name, tenant_ref, max_se, license_type, se_flow_probe_timer, se_dos_profile, disable_se_memory_check, datascript_timeout, udf_log_throttle, vcenter_hosts, vcpus_per_se, cpu_socket_affinity, realtime_se_metrics, config_debugs_on_all_cores, se_dpdk_pmd, memory_for_config_update, custom_tag, non_significant_log_throttle, shm_minimum_config_memory, extra_shared_config_memory, vcenter_datastores, state, se_sb_threads, active_standby, waf_learning_interval, auto_rebalance_capacity_per_se, service_ip6_subnets, reboot_on_stop, se_probe_port, extra_config_multiplier, distribute_load_active_standby, async_ssl_threads, advertise_backend_networks, vcenter_folder, floating_intf_ip, heap_minimum_config_memory, max_memory_per_mempool, ssl_preprocess_sni_hostname, allow_burst, max_cpu_usage, min_scaleout_per_vs, vss_placement, buffer_se, mem_reserve, vcenter_datastore_mode, enable_hsm_priming, auto_rebalance_criteria, least_load_core_selection, aggressive_failure_detection, significant_log_throttle, se_bandwidth_type, additional_config_memory, vs_se_scaleout_additional_wait_time, max_public_ips_per_lb, accelerated_networking, enable_vip_on_all_interfaces, se_routing, auto_rebalance, data_network_id, min_se, se_tunnel_mode, memory_per_se, se_tunnel_udp_port, disable_gro, vs_scaleout_timeout, se_flow_probe_retries, ephemeral_portrange_end, ha_mode, se_remote_punt_udp_port, ingress_access_mgmt, disk_per_se, vs_se_scaleout_ready_timeout, archive_shm_limit, max_vs_per_se, app_learning_memory_percent, enable_multi_lb, openstack_mgmt_network_uuid, n_log_streaming_threads, use_standard_alb, avi_api_update_method, se_vs_hb_max_pkts_in_batch, app_cache_percent, se_sb_dedicated_core, host_attribute_key, se_ipc_udp_port, hypervisor, cpu_reserve, custom_securitygroups_mgmt, enable_vmac, openstack_mgmt_network_name, se_pcap_reinit_threshold, hm_on_standby, distribute_queues, hardwaresecuritymodulegroup_ref, minimum_required_config_memory, ephemeral_portrange_start, se_tracert_port_range, floating_intf_ip_se_2, log_disksz, se_use_dpdk, openstack_availability_zone, auto_rebalance_interval, avi_api_patch_op, vip_asg, ignore_rtt_threshold, openstack_availability_zones, disable_csum_offloads, num_flow_cores_sum_changes_to_ignore, algo, os_reserved_memory, se_pcap_reinit_frequency, description, vs_scalein_timeout_for_upgrade, se_deprovision_delay, se_vs_hb_max_vs_in_pkt, minimum_connection_memory, mgmt_network_ref, license_tier, flow_table_new_syn_max_entries, host_gateway_monitor, url, cloud_ref, vs_switchover_timeout, se_thread_multiplier, waf_mempool_size, dedicated_dispatcher_core, mgmt_subnet, vs_host_redundancy, vss_placement_enabled

This module is used to configure ServiceEngineGroup object more examples at U(https://github.com/avinetworks/devops)

Module for setup of SnmpTrapProfile Avi RESTful Object

Arguments: name, trap_servers, tenant_ref, state, url, avi_api_patch_op, avi_api_update_method, uuid

This module is used to configure SnmpTrapProfile object more examples at U(https://github.com/avinetworks/devops)

Module for setup of SSLKeyAndCertificate Avi RESTful Object

Arguments: status, certificate_management_profile_ref, key_base64, key_passphrase, hardwaresecuritymodulegroup_ref, key, certificate_base64, key_params, avi_api_update_method, name, enckey_base64, dynamic_params, uuid, certificate, url, enckey_name, format, tenant_ref, avi_api_patch_op, created_by, state, ca_certs, type

This module is used to configure SSLKeyAndCertificate object more examples at U(https://github.com/avinetworks/devops)

Module for setup of SSLProfile Avi RESTful Object

Arguments: accepted_ciphers, prefer_client_cipher_ordering, description, tags, accepted_versions, state, avi_api_update_method, name, ssl_session_timeout, uuid, url, ssl_rating, tenant_ref, avi_api_patch_op, enable_ssl_session_reuse, cipher_enums, send_close_notify, dhparam, type

This module is used to configure SSLProfile object more examples at U(https://github.com/avinetworks/devops)

Module for setup of StringGroup Avi RESTful Object

Arguments: uuid, url, description, tenant_ref, state, avi_api_patch_op, kv, type, avi_api_update_method, name

This module is used to configure StringGroup object more examples at U(https://github.com/avinetworks/devops)

Module for setup of SystemConfiguration Avi RESTful Object

Arguments: secure_channel_configuration, docker_mode, welcome_workflow_complete, global_tenant_config, proxy_configuration, ssh_hmacs, linux_configuration, portal_configuration, avi_api_update_method, email_configuration, uuid, snmp_configuration, url, default_license_tier, dns_configuration, avi_api_patch_op, dns_virtualservice_refs, state, ntp_configuration, admin_auth_configuration, mgmt_ip_access_control, ssh_ciphers

This module is used to configure SystemConfiguration object more examples at U(https://github.com/avinetworks/devops)

Module for setup of Tenant Avi RESTful Object

Arguments: uuid, url, state, created_by, name, avi_api_patch_op, config_settings, local, avi_api_update_method, description

This module is used to configure Tenant object more examples at U(https://github.com/avinetworks/devops)

Module for setup of TrafficCloneProfile Avi RESTful Object

Arguments: uuid, cloud_ref, tenant_ref, state, url, avi_api_patch_op, clone_servers, preserve_client_ip, avi_api_update_method, name

This module is used to configure TrafficCloneProfile object more examples at U(https://github.com/avinetworks/devops)

Avi User Module

Arguments: user_profile_ref, name, state, is_active, avi_api_patch_op, email, access, is_superuser, obj_username, avi_api_update_method, obj_password, default_tenant_ref

This module can be used for creation, updation and deletion of a user.

Avi UserAccount Module

Arguments: force_change, old_password

This module can be used for updating the password of a user. This module is useful for setting up admin password for Controller bootstrap.

Module for setup of UserAccountProfile Avi RESTful Object

Arguments: max_concurrent_sessions, uuid, state, url, account_lock_timeout, avi_api_patch_op, max_login_failure_count, max_password_history_count, credentials_timeout_threshold, avi_api_update_method, name

This module is used to configure UserAccountProfile object more examples at U(https://github.com/avinetworks/devops)

Module for setup of VirtualService Avi RESTful Object

Arguments: client_auth, port_uuid, ssl_profile_selectors, availability_zone, error_page_profile_ref, subnet_uuid, delay_fairness, vip, static_dns_records, enable_rhi_snat, sideband_profile, requests_rate_limit, analytics_profile_ref, uuid, ipam_network_subnet, server_network_profile_ref, description, ssl_profile_ref, created_by, topology_policies, max_cps_per_client, pool_group_ref, traffic_enabled, ssl_sess_cache_avg_size, flow_dist, l4_policies, http_policies, application_profile_ref, microservice_ref, use_vip_as_snat, discovered_network_ref, ip_address, azure_availability_set, avi_api_update_method, east_west_placement, floating_subnet_uuid, name, service_pool_select, close_client_conn_on_config_update, type, enable_autogw, discovered_networks, tenant_ref, remove_listening_port_on_vs_down, ssl_key_and_certificate_refs, snat_ip, host_name_xlate, analytics_policy, sp_pool_refs, flow_label_type, network_profile_ref, weight, dns_info, vh_domain_name, security_policy_ref, content_rewrite, traffic_clone_profile_ref, apic_contract_graph, avi_allocated_vip, vrf_context_ref, allow_invalid_client_cert, subnet, service_metadata, cloud_type, network_ref, cloud_ref, enable_rhi, saml_sp_config, waf_policy_ref, dns_policies, scaleout_ecmp, sso_policy, state, nsx_securitygroup, cloud_config_cksum, min_pools_up, vsvip_ref, performance_limits, use_bridge_ip_as_vip, enabled, floating_ip, auto_allocate_floating_ip, avi_api_patch_op, vh_parent_vs_uuid, connections_rate_limit, active_standby_se_tag, pool_ref, ign_pool_net_reach, limit_doser, url, auto_allocate_ip, fqdn, network_security_policy_ref, vs_datascripts, services, avi_allocated_fip, sso_policy_ref, vsvip_cloud_config_cksum, discovered_subnet, se_group_ref, bulk_sync_kvcache

This module is used to configure VirtualService object more examples at U(https://github.com/avinetworks/devops)

Module for setup of VrfContext Avi RESTful Object

Arguments: uuid, static_routes, cloud_ref, tenant_ref, state, name, url, avi_api_patch_op, system_default, avi_api_update_method, gateway_mon, internal_gateway_monitor, debugvrfcontext, bgp_profile, description

This module is used to configure VrfContext object more examples at U(https://github.com/avinetworks/devops)

Module for setup of VSDataScriptSet Avi RESTful Object

Arguments: datascript, uuid, pool_refs, state, url, pool_group_refs, protocol_parser_refs, tenant_ref, string_group_refs, created_by, ipgroup_refs, avi_api_patch_op, name, avi_api_update_method, description

This module is used to configure VSDataScriptSet object more examples at U(https://github.com/avinetworks/devops)

Module for setup of VsVip Avi RESTful Object

Arguments: east_west_placement, vrf_context_ref, name, state, cloud_ref, dns_info, tenant_ref, avi_api_patch_op, url, vip, vsvip_cloud_config_cksum, use_standard_alb, avi_api_update_method, uuid

This module is used to configure VsVip object more examples at U(https://github.com/avinetworks/devops)

Module for setup of Webhook Avi RESTful Object

Arguments: uuid, url, description, tenant_ref, state, verification_token, avi_api_patch_op, callback_url, avi_api_update_method, name

This module is used to configure Webhook object more examples at U(https://github.com/avinetworks/devops)

Manage awall policies

Arguments: state, activate, name

This modules allows for enable/disable/activate of I(awall) policies. Alpine Wall (I(awall)) generates a firewall configuration from the enabled policy files and activates the configuration on the system.

Retrieve certificate information from AWS Certificate Manager service

Arguments: domain_name, statuses

Retrieve information for ACM certificates This module was called C(aws_acm_facts) before Ansible 2.9. The usage did not change.

Manage AWS API Gateway APIs

Arguments: swagger_file, state, swagger_text, swagger_dict, deploy_desc, api_id, stage

Allows for the management of API Gateway APIs Normally you should give the api_id since there is no other stable guaranteed unique identifier for the API. If you do not give api_id then a new API will be create each time this is run. Beware that there are very hard limits on the rate that you can call API Gateway's REST API. You may need to patch your boto. See https://github.com/boto/boto3/issues/876 and discuss with your AWS rep. swagger_file and swagger_text are passed directly on to AWS transparently whilst swagger_dict is an ansible dict which is converted to JSON before the API definitions are uploaded.

Manage Application Auto Scaling Scaling Policies

Arguments: policy_type, minimum_tasks, resource_id, target_tracking_scaling_policy_configuration, step_scaling_policy_configuration, scalable_dimension, service_namespace, override_task_capacity, policy_name, maximum_tasks

Creates, updates or removes a Scaling Policy

Gather information about availability zones in AWS.

Arguments: filters

Gather information about availability zones in AWS. This module was called C(aws_az_facts) before Ansible 2.9. The usage did not change.

Manage AWS Batch Compute Environments

Arguments: subnets, tags, instance_types, bid_percentage, image_id, maxv_cpus, security_group_ids, instance_role, desiredv_cpus, minv_cpus, compute_resource_type, compute_environment_state, state, spot_iam_fleet_role, service_role, compute_environment_name, type, ec2_key_pair

This module allows the management of AWS Batch Compute Environments. It is idempotent and supports "Check" mode. Use module M(aws_batch_compute_environment) to manage the compute environment, M(aws_batch_job_queue) to manage job queues, M(aws_batch_job_definition) to manage job definitions.

Manage AWS Batch Job Definitions

Arguments: readonly_root_filesystem, mount_points, image, job_role_arn, attempts, user, job_definition_arn, parameters, state, environment, vcpus, command, volumes, memory, job_definition_name, type, privileged, ulimits

This module allows the management of AWS Batch Job Definitions. It is idempotent and supports "Check" mode. Use module M(aws_batch_compute_environment) to manage the compute environment, M(aws_batch_job_queue) to manage job queues, M(aws_batch_job_definition) to manage job definitions.

Manage AWS Batch Job Queues

Arguments: priority, compute_environment_order, state, job_queue_name, job_queue_state

This module allows the management of AWS Batch Job Queues. It is idempotent and supports "Check" mode. Use module M(aws_batch_compute_environment) to manage the compute environment, M(aws_batch_job_queue) to manage job queues, M(aws_batch_job_definition) to manage job definitions.

Get information about the user and account being used to make AWS calls.

Arguments:

This module returns information about the account and user / role from which the AWS access tokens originate. The primary use of this is to get the account id for templating into ARNs or similar to avoid needing to specify this information in inventory. This module was called C(aws_caller_facts) before Ansible 2.9. The usage did not change.

Create or delete an AWS CodeBuild project

Arguments: environment, name, tags, artifacts, cache, encryption_key, vpc_config, source, state, service_role, timeout_in_minutes, description

Create or delete a CodeBuild projects on AWS, used for building code artifacts from source code.

Manage repositories in AWS CodeCommit

Arguments: comment, state, name

Supports creation and deletion of CodeCommit repositories. See U(https://aws.amazon.com/codecommit/) for more information about CodeCommit.

Create or delete AWS CodePipelines

Arguments: state, version, role_arn, name, stages, artifact_store

Create or delete a CodePipeline on AWS.

Manage cross-account AWS Config authorizations

Arguments: authorized_account_id, authorized_aws_region, state

Module manages AWS Config resources

Manage AWS Config aggregations across multiple accounts

Arguments: account_sources, state, organization_source, name

Module manages AWS Config resources

Manage AWS Config delivery channels

Arguments: state, s3_prefix, name, delivery_frequency, s3_bucket, sns_topic_arn

This module manages AWS Config delivery locations for rule checks and configuration info

Manage AWS Config Recorders

Arguments: state, role_arn, recording_group, name

Module manages AWS Config configuration recorder settings

Manage AWS Config resources

Arguments: source, execution_frequency, name, input_parameters, scope, state, description

Module manages AWS Config rules

Creates, deletes, modifies a DirectConnect connection

Arguments: forced_update, bandwidth, name, state, link_aggregation_group, connection_id, location

Create, update, or delete a Direct Connect connection between a network and a specific AWS Direct Connect location. Upon creation the connection may be added to a link aggregation group or established as a standalone connection. The connection may later be associated or disassociated with a link aggregation group.

Manage AWS Direct Connect Gateway.

Arguments: direct_connect_gateway_id, state, virtual_gateway_id, name, amazon_asn

Creates AWS Direct Connect Gateway Deletes AWS Direct Connect Gateway Attaches Virtual Gateways to Direct Connect Gateway Detaches Virtual Gateways to Direct Connect Gateway

Manage Direct Connect LAG bundles.

Arguments: name, state, delete_with_disassociation, force_delete, num_connections, connection_id, bandwidth, wait_timeout, location, min_links, link_aggregation_group_id, wait

Create, delete, or modify a Direct Connect link aggregation group.

Manage Direct Connect virtual interfaces.

Arguments: vlan, name, virtual_interface_id, id_to_associate, customer_address, state, amazon_address, authentication_key, bgp_asn, cidr, address_type, virtual_gateway_id, public

Create, delete, or modify a Direct Connect public or private virtual interface.

Manage Elastic Kubernetes Service Clusters

Arguments: subnets, role_arn, name, state, wait_timeout, version, security_groups, wait

Manage Elastic Kubernetes Service Clusters

create, update, and delete an elastic beanstalk application

Arguments: state, description, terminate_by_force, app_name

creates, updates, deletes beanstalk applications if app_name is provided

Manage an AWS Glue connection

Arguments: connection_type, connection_properties, name, match_criteria, subnet_id, state, catalog_id, security_groups, description

Manage an AWS Glue connection. See U(https://aws.amazon.com/glue/) for details.

Manage an AWS Glue job

Arguments: description, allocated_capacity, max_concurrent_runs, max_retries, connections, state, default_arguments, role, timeout, command_name, command_script_location, name

Manage an AWS Glue job. See U(https://aws.amazon.com/glue/) for details.

Create, Update and Delete Amazon Inspector Assessment Targets

Arguments: state, name, tags

Creates, updates, or deletes Amazon Inspector Assessment Targets and manages the required Resource Groups.

Perform various KMS management tasks.

Arguments: alias, policy_grant_types, description, tags, purge_tags, enabled, policy_clean_invalid_entries, state, grants, key_id, policy, purge_grants, policy_role_name, policy_role_arn, policy_mode

Manage role/user access to a KMS key. Not designed for encrypting/decrypting.

Gather information about AWS KMS keys

Arguments: pending_deletion, filters

Gather information about AWS KMS keys including tags and grants This module was called C(aws_kms_facts) before Ansible 2.9. The usage did not change.

NetApp AWS CloudVolumes Service Manage Active Directory.

Arguments: username, domain, DNS, region, password, state, netBIOS

Create, Update, Delete ActiveDirectory on AWS Cloud Volumes Service.

NetApp AWS Cloud Volumes Service Manage FileSystem.

Arguments: state, quotaInBytes, exportPolicy, creationToken, region, serviceLevel

Create, Update, Delete fileSystem on AWS Cloud Volumes Service.

NetApp AWS Cloud Volumes Service Manage Pools.

Arguments: sizeInBytes, vendorID, state, from_name, name, region, serviceLevel

Create, Update, Delete Pool on AWS Cloud Volumes Service.

NetApp AWS Cloud Volumes Service Manage Snapshots.

Arguments: region, fileSystemId, from_name, state, name

Create, Update, Delete Snapshot on AWS Cloud Volumes Service.

Gather information about AWS regions.

Arguments: filters

Gather information about AWS regions. This module was called C(aws_region_facts) before Ansible 2.9. The usage did not change.

manage objects in S3.

Arguments: encryption_kms_key_id, permission, dest, object, encryption_mode, prefix, marker, ignore_nonexistent_bucket, dualstack, overwrite, headers, aws_secret_key, src, aws_access_key, encrypt, rgw, region, bucket, retries, max_keys, version, expiration, s3_url, metadata, mode

This module allows the user to manage S3 buckets and the objects within them. Includes support for creating and deleting both objects and buckets, retrieving objects as files or strings and generating download links. This module has a dependency on boto3 and botocore.

Lists S3 buckets in AWS

Arguments:

Lists S3 buckets in AWS This module was called C(aws_s3_bucket_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(aws_s3_bucket_info) module no longer returns C(ansible_facts)!

Manage CORS for S3 buckets in AWS

Arguments: rules, state, name

Manage CORS for S3 buckets in AWS

Manage secrets stored in AWS Secrets Manager.

Arguments: secret_type, kms_key_id, name, rotation_interval, tags, state, secret, recovery_window, rotation_lambda, description

Create, update, and delete secrets stored in AWS Secrets Manager.

Manages SES email and domain identity

Arguments: bounce_notifications, state, delivery_notifications, feedback_forwarding, complaint_notifications, identity

This module allows the user to manage verified email and domain identity for SES. This covers verifying and removing identities as well as setting up complaint, bounce and delivery notification settings.

Manages SES sending authorization policies

Arguments: policy, state, identity, policy_name

This module allows the user to manage sending authorization policies associated with an SES identity (email or domain). SES authorization sending policies can be used to control what actors are able to send email on behalf of the validated identity and what conditions must be met by the sent emails.

Manages SES inbound receipt rule sets

Arguments: active, state, force, name

The M(aws_ses_rule_set) module allows you to create, delete, and manage SES receipt rule sets

Fetch AWS Storage Gateway information

Arguments: gather_local_disks, gather_file_shares, gather_tapes, gather_volumes

Fetch AWS Storage Gateway information This module was called C(aws_sgw_facts) before Ansible 2.9. The usage did not change.

Manage key-value pairs in aws parameter store.

Arguments: decryption, name, region, string_type, value, state, key_id, overwrite_value, description

Manage key-value pairs in aws parameter store.

create and delete WAF Conditions

Arguments: state, name, filters, purge_filters, type, waf_regional

Read the AWS documentation for WAF U(https://aws.amazon.com/documentation/waf/)

Retrieve information for WAF ACLs, Rule , Conditions and Filters.

Arguments: name, waf_regional

Retrieve information for WAF ACLs, Rule , Conditions and Filters. This module was called C(aws_waf_facts) before Ansible 2.9. The usage did not change.

create and delete WAF Rules

Arguments: state, name, purge_conditions, conditions, waf_regional, metric_name

Read the AWS documentation for WAF U(https://aws.amazon.com/documentation/waf/)

create and delete WAF Web ACLs

Arguments: state, metric_name, purge_rules, rules, default_action, waf_regional, name

Read the AWS documentation for WAF U(https://aws.amazon.com/documentation/waf/)

Manage an Azure Container Service(ACS) instance

Arguments: linux_profile, master_profile, name, resource_group, orchestration_platform, agent_pool_profiles, state, location, service_principal, diagnostics_profile

Create, update and delete an Azure Container Service(ACS) instance.

Manage a managed Azure Container Service (AKS) instance

Arguments: linux_profile, kubernetes_version, name, resource_group, agent_pool_profiles, enable_rbac, state, network_profile, location, aad_profile, service_principal, dns_prefix, addon

Create, update and delete a managed Azure Container Service (AKS) instance.

Get Azure Kubernetes Service facts

Arguments: show_kubeconfig, name, resource_group, tags

Get facts for a specific Azure Kubernetes Service or all Azure Kubernetes Services.

Get available kubernetes versions supported by Azure Kubernetes Service

Arguments: version, location

Get available kubernetes versions supported by Azure Kubernetes Service.

Manage Application Gateway instance

Arguments: backend_http_settings_collection, authentication_certificates, ssl_policy, resource_group, redirect_configurations, request_routing_rules, probes, sku, name, ssl_certificates, backend_address_pools, frontend_ip_configurations, state, http_listeners, location, gateway_ip_configurations, frontend_ports

Create, update and delete instance of Application Gateway.

Manage Azure Application Security Group

Arguments: state, name, resource_group, location

Create, update and delete instance of Azure Application Security Group.

Get Azure Application Security Group facts

Arguments: name, resource_group, tags

Get facts of Azure Application Security Group.

Manage App Service Plan

Arguments: sku, number_of_workers, state, name, resource_group, is_linux, location

Create, update and delete instance of App Service Plan.

Get azure app service plan facts

Arguments: name, resource_group, tags

Get facts for a specific app service plan or all app service plans in a resource group, or all app service plan in current subscription.

Manage Azure Automation account

Arguments: state, name, resource_group, location

Create, delete an Azure Automation account.

Get Azure automation account facts

Arguments: list_usages, list_statistics, list_keys, name, resource_group, tags

Get facts of automation account.

Manage Azure autoscale setting

Arguments: target, resource_group, enabled, profiles, notifications, state, location, name

Create, delete an autoscale setting.

Get Azure Auto Scale Setting facts

Arguments: name, resource_group, tags

Get facts of Auto Scale Setting.

Manage Azure Availability Set

Arguments: sku, platform_fault_domain_count, state, name, resource_group, platform_update_domain_count, location

Create, update and delete Azure Availability Set. An availability set cannot be updated, you will have to recreate one instead. The only update operation will be for the tags.

Get Azure Availability Set facts

Arguments: name, resource_group, tags

Get facts for a specific availability set or all availability sets.

Manage Azure Firewall instance.

Arguments: name, resource_group, nat_rule_collections, network_rule_collections, application_rule_collections, state, location, ip_configurations

Create, update and delete instance of Azure Firewall.

Get AzureFirewall info.

Arguments: name, resource_group

Get info of AzureFirewall.

Manages a Batch Account on Azure.

Arguments: state, pool_allocation_mode, name, resource_group, auto_storage_account, location, key_vault

Create, update and delete instance of Azure Batch Account.

Manage a Azure CDN endpoint

Arguments: resource_group, started, is_https_allowed, query_string_caching_behavior, profile_name, purge_content_paths, origin_host_header, name, origins, origin_path, purge, state, location, content_types_to_compress, is_http_allowed, is_compression_enabled

Create, update, start, stop and delete a Azure CDN endpoint.

Get Azure CDN endpoint facts

Arguments: profile_name, name, resource_group, tags

Get facts for a specific Azure CDN endpoint or all Azure CDN endpoints.

Manage a Azure CDN profile

Arguments: sku, state, name, resource_group, location

Create, update and delete a Azure CDN profile.

Get Azure CDN profile facts

Arguments: name, resource_group, tags

Get facts for a specific Azure CDN profile or all CDN profiles.

Manage an Azure Container Instance

Arguments: registry_username, name, resource_group, dns_name_label, force_update, restart_policy, state, registry_password, registry_login_server, location, os_type, ip_address, ports, containers

Create, update and delete an Azure Container Instance.

Get Azure Container Instance facts

Arguments: name, resource_group, tags

Get facts of Container Instance.

Manage an Azure Container Registry

Arguments: sku, state, name, resource_group, admin_user_enabled, location

Create, update and delete an Azure Container Registry.

Get Azure Container Registry facts

Arguments: retrieve_credentials, name, resource_group, tags

Get facts for Container Registry.

Manage Azure Database Account instance

Arguments: enable_automatic_failover, resource_group, geo_rep_locations, virtual_network_rules, database_account_offer_type, is_virtual_network_filter_enabled, enable_gremlin, enable_multiple_write_locations, enable_table, kind, name, consistency_policy, ip_range_filter, state, location, enable_cassandra

Create, update and delete instance of Azure Database Account.

Get Azure Cosmos DB Account facts

Arguments: resource_group, tags, name, retrieve_keys, retrieve_connection_strings

Get facts of Azure Cosmos DB Account.

Create or destroy Azure Resource Manager template deployments

Arguments: wait_for_deployment_completion, resource_group, wait_for_deployment_polling_period, template_link, name, state, location, deployment_mode, parameters_link, parameters, template

Create or destroy Azure Resource Manager template deployments via the Azure SDK for Python. You can find some quick start templates in GitHub here U(https://github.com/azure/azure-quickstart-templates). For more information on Azure Resource Manager templates see U(https://azure.microsoft.com/en-us/documentation/articles/resource-group-template-deploy/).

Get Azure Deployment facts

Arguments: name, resource_group

Get facts of Azure Deployment.

Manage Azure DevTest Lab instance

Arguments: storage_type, name, resource_group, premium_data_disks, state, location

Create, update and delete instance of Azure DevTest Lab.

Get Azure DevTest Lab facts

Arguments: name, resource_group, tags

Get facts of Azure DevTest Lab.

Get Azure DevTest Lab ARM Template facts

Arguments: artifact_source_name, lab_name, name, resource_group

Get facts of Azure DevTest Lab ARM Template.

Get Azure DevTest Lab Artifact facts

Arguments: artifact_source_name, lab_name, name, resource_group

Get facts of Azure DevTest Lab Artifact.

Manage Azure DevTest Labs Artifacts Source instance

Arguments: is_enabled, display_name, name, security_token, lab_name, resource_group, uri, source_type, state, branch_ref, arm_template_folder_path, folder_path

Create, update and delete instance of Azure DevTest Labs Artifacts Source.

Get Azure DevTest Lab Artifact Source facts

Arguments: lab_name, name, resource_group, tags

Get facts of Azure DevTest Lab Artifact Source.

Manage Azure DevTest Lab Custom Image instance

Arguments: windows_os_state, name, resource_group, linux_os_state, author, source_vm, lab_name, state, description

Create, update and delete instance of Azure DevTest Lab Custom Image.

Get Azure DevTest Lab Custom Image facts

Arguments: lab_name, name, resource_group, tags

Get facts of Azure Azure DevTest Lab Custom Image.

Manage Azure DevTest Lab Environment instance

Arguments: name, resource_group, lab_name, deployment_parameters, state, deployment_template, user_name, location

Create, update and delete instance of Azure DevTest Lab Environment.

Get Azure Environment facts

Arguments: lab_name, user_name, name, resource_group, tags

Get facts of Azure Environment.

Manage Azure Policy instance

Arguments: fact_name, name, resource_group, policy_set_name, lab_name, state, threshold, description

Create, update and delete instance of Azure Policy.

Get Azure DTL Policy facts

Arguments: policy_set_name, lab_name, name, resource_group, tags

Get facts of Azure DTL Policy.

Manage Azure DevTest Lab Schedule instance

Arguments: lab_name, state, name, resource_group, time, time_zone_id

Create, update and delete instance of Azure DecTest Lab Schedule.

Get Azure Schedule facts

Arguments: lab_name, name, resource_group, tags

Get facts of Azure Schedule.

Manage Azure DevTest Lab Virtual Machine instance

Arguments: lab_subnet, resource_group, image, ssh_key, allow_claim, storage_type, disallow_public_ip_address, vm_size, password, name, artifacts, expiration_date, notes, lab_name, state, os_type, user_name

Create, update and delete instance of Azure DevTest Lab Virtual Machine.

Get Azure DevTest Lab Virtual Machine facts

Arguments: lab_name, name, resource_group, tags

Get facts of Azure DevTest Lab Virtual Machine.

Manage Azure DevTest Lab Virtual Network instance

Arguments: lab_name, state, description, resource_group, name, location

Create, update and delete instance of Azure DevTest Lab Virtual Network.

Get Azure DevTest Lab Virtual Network facts

Arguments: lab_name, name, resource_group

Get facts of Azure DevTest Lab Virtual Network.

Create, delete and update DNS record sets and records

Arguments: resource_group, record_type, record_mode, state, relative_name, records, time_to_live, zone_name

Creates, deletes, and updates DNS records sets and records within an existing Azure DNS Zone.

Get DNS Record Set facts

Arguments: zone_name, top, relative_name, resource_group, record_type

Get facts for a specific DNS Record Set in a Zone, or a specific type in all Zones or in one Zone etc.

Manage Azure DNS zones

Arguments: registration_virtual_networks, state, name, resource_group, resolution_virtual_networks, type

Creates and deletes Azure DNS zones.

Get DNS zone facts

Arguments: name, resource_group, tags

Get facts for a specific DNS zone or all DNS zones within a resource group.

Manage Azure Function Apps

Arguments: name, resource_group, state, location, app_settings, storage_account, plan, container_settings

Create, update or delete an Azure Function App.

Get Azure Function App facts

Arguments: name, resource_group, tags

Get facts for one Azure Function App or all Function Apps within a resource group.

Manage Azure Shared Image Gallery instance.

Arguments: state, location, description, resource_group, name

Create, update and delete instance of Azure Shared Image Gallery (SIG).

Get Azure Shared Image Gallery info.

Arguments: name, resource_group

Get info of Azure Shared Image Gallery.

Manage Azure SIG Image instance.

Arguments: eula, gallery_name, description, resource_group, os_state, privacy_statement_uri, release_note_uri, name, recommended, end_of_life_date, state, location, purchase_plan, os_type, identifier, disallowed

Create, update and delete instance of Azure SIG Image.

Get Azure SIG Image info.

Arguments: gallery_name, name, resource_group

Get info of Azure SIG Image.

Manage Azure SIG Image Version instance.

Arguments: gallery_image_name, state, gallery_name, name, resource_group, publishing_profile, location

Create, update and delete instance of Azure SIG Image Version.

Get Azure SIG Image Version info.

Arguments: gallery_image_name, gallery_name, name, resource_group

Get info of Azure SIG Image Version.

Manage Azure HDInsight Cluster instance

Arguments: name, storage_accounts, cluster_version, resource_group, tier, state, location, compute_profile_roles, os_type, cluster_definition

Create, update and delete instance of Azure HDInsight Cluster.

Get Azure HDInsight Cluster facts

Arguments: name, resource_group, tags

Get facts of Azure HDInsight Cluster.

Manage Azure image

Arguments: source, state, name, resource_group, os_type, data_disk_sources, location

Create, delete an image from virtual machine, blob uri, managed disk or snapshot.

Get facts about azure custom images

Arguments: name, resource_group, tags

List azure custom images. The images can be listed where scope of listing can be based on subscription, resource group, name or tags.

Manage Azure IoT hub device

Arguments: status, name, hub, secondary_key, twin_tags, desired, state, edge_enabled, hub_policy_name, hub_policy_key, auth_method, primary_key

Create, delete an Azure IoT hub device.

Facts of Azure IoT hub device

Arguments: name, hub, module_id, query, top, hub_policy_name, hub_policy_key

Query, get Azure IoT hub device.

Manage Azure IoT hub device module

Arguments: name, hub, secondary_key, twin_tags, desired, state, device, hub_policy_name, hub_policy_key, auth_method, primary_key

Create, delete an Azure IoT hub device module.

Manage Azure IoT hub

Arguments: sku, name, resource_group, event_endpoint, routing_endpoints, enable_file_upload_notifications, state, location, routes, ip_filters, unit

Create, delete an Azure IoT hub.

Get IoT Hub facts

Arguments: show_stats, name, resource_group, tags, show_quota_metrics, test_route_message, list_consumer_groups, list_keys, show_endpoint_health

Get facts for a specific IoT Hub or all IoT Hubs.

Manage Azure IoT hub

Arguments: event_hub, state, name, hub, resource_group

Create, delete an Azure IoT hub.

Manage Key Vault instance

Arguments: sku, resource_group, recover_mode, enabled_for_disk_encryption, enabled_for_template_deployment, state, vault_name, enabled_for_deployment, access_policies, vault_tenant, enable_soft_delete, location

Create, update and delete instance of Key Vault.

Get Azure Key Vault facts

Arguments: name, resource_group, tags

Get facts of Azure Key Vault.

Use Azure KeyVault keys

Arguments: keyvault_uri, pem_password, byok_file, key_name, state, pem_file

Create or delete a key within a given keyvault. By using Key Vault, you can encrypt keys and secrets. Such as authentication keys, storage account keys, data encryption keys, .PFX files, and passwords.

Get Azure Key Vault key facts.

Arguments: show_deleted_key, vault_uri, version, name, tags

Get facts of Azure Key Vault key.

Use Azure KeyVault Secrets

Arguments: keyvault_uri, state, secret_name, secret_value

Create or delete a secret within a given keyvault. By using Key Vault, you can encrypt keys and secrets. Such as authentication keys, storage account keys, data encryption keys, .PFX files, and passwords.

Manage Azure load balancers

Arguments: public_ip_address_name, probe_port, load_balancing_rules, resource_group, natpool_protocol, inbound_nat_pools, idle_timeout, probe_interval, probe_protocol, load_distribution, frontend_port, natpool_frontend_port_start, backend_port, probes, sku, probe_fail_count, natpool_frontend_port_end, natpool_backend_port, name, backend_address_pools, inbound_nat_rules, protocol, frontend_ip_configurations, state, location, probe_request_path

Create, update and delete Azure load balancers.

Get load balancer facts

Arguments: name, resource_group, tags

Get facts for a specific load balancer or all load balancers.

Manage Azure locks

Arguments: managed_resource_id, state, name, resource_group, level

Create, delete an Azure lock. To create or delete management locks, you must have access to Microsoft.Authorization/* or Microsoft.Authorization/locks/* actions. Of the built-in roles, only Owner and User Access Administrator are granted those actions.

Manage Azure locks

Arguments: name, resource_group, managed_resource_id

Create, delete an Azure lock.

Manage Azure Log Analytics workspaces

Arguments: sku, intelligence_packs, state, retention_in_days, name, resource_group, location

Create, delete Azure Log Analytics workspaces.

Get facts of Azure Log Analytics workspaces

Arguments: show_management_groups, show_shared_keys, name, resource_group, tags, show_intelligence_packs, show_usages

Get, query Azure Log Analytics workspaces.

Manage Azure Manage Disks

Arguments: attach_caching, disk_size_gb, name, resource_group, tags, source_uri, storage_account_type, state, managed_by, location, os_type, zone, create_option

Create, update and delete an Azure Managed Disk.

Get managed disk facts

Arguments: name, resource_group, tags

Get facts for a specific managed disk or all managed disks.

Manage Configuration instance

Arguments: name, state, server_name, value, resource_group

Create, update and delete instance of Configuration.

Get Azure MariaDB Configuration facts

Arguments: resource_group, server_name, name

Get facts of Azure MariaDB Configuration.

Manage MariaDB Database instance

Arguments: state, charset, server_name, resource_group, collation, force_update, name

Create, update and delete instance of MariaDB Database.

Get Azure MariaDB Database facts

Arguments: resource_group, server_name, name

Get facts of MariaDB Database.

Manage MariaDB firewall rule instance

Arguments: state, server_name, resource_group, start_ip_address, end_ip_address, name

Create, update and delete instance of MariaDB firewall rule.

Get Azure MariaDB Firewall Rule facts

Arguments: resource_group, server_name, name

Get facts of Azure MariaDB Firewall Rule.

Manage MariaDB Server instance

Arguments: sku, name, resource_group, storage_mb, admin_username, create_mode, state, version, location, enforce_ssl, admin_password

Create, update and delete instance of MariaDB Server.

Get Azure MariaDB Server facts

Arguments: name, resource_group, tags

Get facts of MariaDB Server.

Manage Azure Monitor log profile

Arguments: retention_policy, name, locations, state, location, service_bus_rule_id, storage_account, categories

Create, update and delete instance of Azure Monitor log profile.

Manage Configuration instance

Arguments: name, state, server_name, value, resource_group

Create, update and delete instance of Configuration.

Get Azure MySQL Configuration facts

Arguments: resource_group, server_name, name

Get facts of Azure MySQL Configuration.

Manage MySQL Database instance

Arguments: state, charset, server_name, resource_group, collation, force_update, name

Create, update and delete instance of MySQL Database.

Get Azure MySQL Database facts

Arguments: resource_group, server_name, name

Get facts of MySQL Database.

Manage MySQL firewall rule instance

Arguments: state, server_name, resource_group, start_ip_address, end_ip_address, name

Create, update and delete instance of MySQL firewall rule.

Get Azure MySQL Firewall Rule facts

Arguments: resource_group, server_name, name

Get facts of Azure MySQL Firewall Rule.

Manage MySQL Server instance

Arguments: sku, name, resource_group, storage_mb, admin_username, create_mode, state, version, location, enforce_ssl, admin_password

Create, update and delete instance of MySQL Server.

Get Azure MySQL Server facts

Arguments: name, resource_group, tags

Get facts of MySQL Server.

Manage Azure network interfaces

Arguments: dns_servers, private_ip_address, resource_group, public_ip_allocation_method, open_ports, public_ip, private_ip_allocation_method, enable_accelerated_networking, ip_configurations, public_ip_address_name, name, enable_ip_forwarding, state, subnet_name, location, create_with_security_group, security_group, virtual_network, os_type

Create, update or delete a network interface. When creating a network interface you must provide the name of an existing virtual network, the name of an existing subnet within the virtual network. A default security group and public IP address will be created automatically. Or you can provide the name of an existing security group and public IP address. See the examples below for more details.

Get network interface facts

Arguments: name, resource_group, tags

Get facts for a specific network interface or all network interfaces within a resource group.

Manage Azure PostgreSQL Configuration

Arguments: name, state, server_name, value, resource_group

Update or reset Azure PostgreSQL Configuration setting.

Get Azure PostgreSQL Configuration facts

Arguments: resource_group, server_name, name

Get facts of Azure PostgreSQL Configuration.

Manage PostgreSQL Database instance

Arguments: state, charset, server_name, resource_group, collation, force_update, name

Create, update and delete instance of PostgreSQL Database.

Get Azure PostgreSQL Database facts

Arguments: resource_group, server_name, name

Get facts of PostgreSQL Database.

Manage PostgreSQL firewall rule instance

Arguments: state, server_name, resource_group, start_ip_address, end_ip_address, name

Create, update and delete instance of PostgreSQL firewall rule.

Get Azure PostgreSQL Firewall Rule facts

Arguments: resource_group, server_name, name

Get facts of Azure PostgreSQL Firewall Rule.

Manage PostgreSQL Server instance

Arguments: sku, name, resource_group, storage_mb, admin_username, create_mode, state, version, location, enforce_ssl, admin_password

Create, update and delete instance of PostgreSQL Server.

Get Azure PostgreSQL Server facts

Arguments: name, resource_group, tags

Get facts of PostgreSQL Server.

Manage Azure Public IP Addresses

Arguments: sku, name, resource_group, state, domain_name, idle_timeout, version, location, allocation_method, ip_tags

Create, update and delete a Public IP address. Allows setting and updating the address allocation method and domain name label. Use the M(azure_rm_networkinterface) module to associate a Public IP with a network interface.

Get public IP facts

Arguments: name, resource_group, tags

Get facts for a specific public IP or all public IPs within a resource group.

Manage Azure Cache for Redis instance

Arguments: maxfragmentationmemory_reserved, resource_group, shard_count, maxmemory_policy, static_ip, regenerate_key, notify_keyspace_events, sku, subnet, enable_non_ssl_port, name, maxmemory_reserved, wait_for_provisioning, reboot, state, location, tenant_settings

Create, update and delete instance of Azure Cache for Redis.

Get Azure Cache for Redis instance facts

Arguments: return_access_keys, name, resource_group, tags

Get facts for Azure Cache for Redis instance.

Manage Azure Cache for Redis Firewall rules

Arguments: state, end_ip_address, name, resource_group, start_ip_address, cache_name

Create, update and delete Azure Cache for Redis Firewall rules.

Create any Azure resource

Arguments: body, resource_name, subresource, resource_group, url, status_code, provider, idempotency, state, resource_type, polling_interval, polling_timeout, method, api_version

Create, update or delete any Azure resource using Azure REST API. This module gives access to resources that are not supported via Ansible modules. Refer to U(https://docs.microsoft.com/en-us/rest/api/) regarding details related to specific resource REST API.

Generic facts of Azure resources

Arguments: resource_type, resource_name, subresource, resource_group, provider, url, api_version

Obtain facts of any resource using Azure REST API. This module gives access to resources that are not supported via Ansible modules. Refer to U(https://docs.microsoft.com/en-us/rest/api/) regarding details related to specific resource REST API.

Manage Azure resource groups

Arguments: state, location, force_delete_nonempty, name

Create, update and delete a resource group.

Get resource group facts

Arguments: list_resources, name, tags

Get facts for a specific resource group or all resource groups.

Manage Azure Role Assignment

Arguments: assignee_object_id, role_definition_id, scope, state, name

Create and delete instance of Azure Role Assignment.

Gets Azure Role Assignment facts

Arguments: scope, role_definition_id, name, assignee

Gets facts of Azure Role Assignment.

Manage Azure Role Definition

Arguments: state, description, name, scope, assignable_scopes, permissions

Create, update and delete instance of Azure Role Definition.

Get Azure Role Definition facts

Arguments: scope, role_name, type, id

Get facts of Azure Role Definition.

Manage Azure route resource

Arguments: state, next_hop_type, route_table_name, name, resource_group, next_hop_ip_address, address_prefix

Create, update or delete a route.

Manage Azure route table resource

Arguments: state, location, name, disable_bgp_route_propagation, resource_group

Create, update or delete a route table.

Get route table facts

Arguments: name, resource_group, tags

Get facts for a specific route table or all route table in a resource group or subscription.

Manage Azure network security groups

Arguments: resource_group, purge_rules, rules, default_rules, purge_default_rules, state, location, name

Create, update or delete a network security group. A security group contains Access Control List (ACL) rules that allow or deny network traffic to subnets or individual network interfaces. A security group is created with a set of default security rules and an empty set of security rules. Shape traffic flow by adding rules to the empty set of security rules.

Get security group facts

Arguments: name, resource_group, tags

Get facts for a specific security group or all security groups within a resource group.

Manage Azure Service Bus

Arguments: sku, state, name, resource_group, location

Create, update or delete an Azure Service Bus namespaces.

Get servicebus facts

Arguments: topic, name, resource_group, tags, type, namespace, show_sas_policies

Get facts for a specific servicebus or all servicebus in a resource group or subscription.

Manage Azure Service Bus queue

Arguments: status, max_size_in_mb, default_message_time_to_live_seconds, duplicate_detection_time_in_seconds, resource_group, enable_batched_operations, auto_delete_on_idle_in_seconds, enable_express, max_delivery_count, lock_duration_in_seconds, name, requires_duplicate_detection, requires_session, namespace, enable_partitioning, dead_lettering_on_message_expiration, forward_dead_lettered_messages_to, state, forward_to

Create, update or delete an Azure Service Bus queue.

Manage Azure Service Bus SAS policy

Arguments: queue, name, resource_group, rights, namespace, regenerate_secondary_key, regenerate_primary_key, topic, state

Create, update or delete an Azure Service Bus SAS policy.

Manage Azure Service Bus

Arguments: max_size_in_mb, status, default_message_time_to_live_seconds, duplicate_detection_time_in_seconds, name, resource_group, namespace, enable_batched_operations, auto_delete_on_idle_in_seconds, enable_partitioning, state, enable_express, support_ordering, requires_duplicate_detection

Create, update or delete an Azure Service Bus topics.

Manage Azure Service Bus subscription

Arguments: status, default_message_time_to_live_seconds, duplicate_detection_time_in_seconds, resource_group, enable_batched_operations, auto_delete_on_idle_in_seconds, topic, max_delivery_count, dead_lettering_on_filter_evaluation_exceptions, lock_duration_in_seconds, name, requires_session, namespace, dead_lettering_on_message_expiration, forward_dead_lettered_messages_to, state, forward_to

Create, update or delete an Azure Service Bus subscriptions.

Manage Azure Snapshot instance.

Arguments: sku, state, name, resource_group, os_type, creation_data, location

Create, update and delete instance of Azure Snapshot.

Manage SQL Database instance

Arguments: resource_group, recovery_services_recovery_point_resource_id, edition, elastic_pool_name, max_size_bytes, zone_redundant, name, restore_point_in_time, server_name, create_mode, source_database_deletion_date, force_update, collation, source_database_id, state, location, sample_name, read_scale

Create, update and delete instance of SQL Database.

Get Azure SQL Database facts

Arguments: name, resource_group, elastic_pool_name, server_name, tags

Get facts of Azure SQL Database.

Manage Firewall Rule instance

Arguments: state, server_name, resource_group, start_ip_address, end_ip_address, name

Create, update and delete instance of Firewall Rule.

Get Azure SQL Firewall Rule facts

Arguments: resource_group, server_name, name

Get facts of SQL Firewall Rule.

Manage SQL Server instance

Arguments: name, resource_group, admin_username, state, version, admin_password, identity, location

Create, update and delete instance of SQL Server.

Get SQL Server facts

Arguments: resource_group, server_name

Get facts of SQL Server.

Manage Azure storage accounts

Arguments: kind, account_type, custom_domain, resource_group, blob_cors, name, state, location, access_tier, https_only, force_delete_nonempty

Create, update or delete a storage account.

Get storage account facts

Arguments: tags, show_connection_string, name, resource_group, show_blob_cors

Get facts for one storage account or all storage accounts within a resource group.

Manage blob containers and blob objects

Arguments: force, resource_group, dest, content_language, content_type, public_access, src, container, blob_type, state, blob, content_md5, storage_account_name, content_disposition, cache_control, content_encoding

Create, update and delete blob containers and blob objects. Use to upload a file and store it as a blob object, or download a blob object to a file.

Manage Azure subnets

Arguments: name, resource_group, virtual_network_name, address_prefix_cidr, state, route_table, service_endpoints, security_group

Create, update or delete a subnet within a given virtual network. Allows setting and updating the address prefix CIDR, which must be valid within the context of the virtual network. Use the M(azure_rm_networkinterface) module to associate interfaces with the subnet and assign specific IP addresses.

Get Azure Subnet facts

Arguments: virtual_network_name, name, resource_group

Get facts of Azure Subnet.

Manage Azure Traffic Manager endpoint

Arguments: target_resource_id, name, resource_group, min_child_endpoints, enabled, weight, priority, state, profile_name, geo_mapping, location, type, target

Create, update and delete Azure Traffic Manager endpoint.

Get Azure Traffic Manager endpoint facts

Arguments: profile_name, type, name, resource_group

Get facts for a specific Traffic Manager endpoints or all endpoints in a Traffic Manager profile.

Manage Azure Traffic Manager profile

Arguments: routing_method, name, resource_group, dns_config, state, location, monitor_config, profile_status

Create, update and delete a Traffic Manager profile.

Get Azure Traffic Manager profile facts

Arguments: name, resource_group, tags

Get facts for a Azure specific Traffic Manager profile or all Traffic Manager profiles.

Manage Azure virtual machines

Arguments: virtual_network_resource_group, resource_group, public_ip_allocation_method, image, zones, managed_disk_type, ssh_public_keys, os_disk_name, storage_container_name, allocated, ssh_password_enabled, storage_blob_name, remove_on_absent, availability_set, winrm, short_hostname, started, state, subnet_name, admin_password, network_interface_names, generalized, location, virtual_network_name, custom_data, open_ports, plan, accept_terms, vm_size, os_disk_size_gb, name, restarted, boot_diagnostics, admin_username, vm_identity, license_type, os_type, storage_account_name, data_disks, os_disk_caching

Manage and configure virtual machines (VMs) and associated resources on Azure. Requires a resource group containing at least one virtual network with at least one subnet. Supports images from the Azure Marketplace, which can be discovered with M(azure_rm_virtualmachineimage_facts). Supports custom images since Ansible 2.5. To use I(custom_data) on a Linux image, the image must have cloud-init enabled. If cloud-init is not enabled, I(custom_data) is ignored.

Get virtual machine facts

Arguments: name, resource_group, tags

Get facts for one or all virtual machines in a resource group.

Managed Azure Virtual Machine extension

Arguments: publisher, virtual_machine_extension_type, name, resource_group, settings, state, location, protected_settings, type_handler_version, auto_upgrade_minor_version, virtual_machine_name

Create, update and delete Azure Virtual Machine Extension. Note that this module was called M(azure_rm_virtualmachine_extension) before Ansible 2.8. The usage did not change.

Get Azure Virtual Machine Extension facts

Arguments: virtual_machine_name, name, resource_group, tags

Get facts of Azure Virtual Machine Extension.

Get virtual machine image facts

Arguments: sku, publisher, version, location, offer

Get facts for virtual machine images.

Manage Azure virtual machine scale sets

Arguments: load_balancer, application_gateway, virtual_network_resource_group, resource_group, virtual_network_name, image, upgrade_policy, zones, managed_disk_type, ssh_public_keys, enable_accelerated_networking, tier, vm_size, ssh_password_enabled, remove_on_absent, capacity, name, overprovision, admin_username, short_hostname, state, subnet_name, location, single_placement_group, custom_data, security_group, os_type, os_disk_caching, data_disks, admin_password

Create and update a virtual machine scale set. Note that this module was called M(azure_rm_virtualmachine_scaleset) before Ansible 2.8. The usage did not change.

Get Virtual Machine Scale Set facts

Arguments: tags, name, resource_group, format

Get facts for a virtual machine scale set. Note that this module was called M(azure_rm_virtualmachine_scaleset_facts) before Ansible 2.8. The usage did not change.

Manage Azure Virtual Machine Scale Set (VMSS) extensions

Arguments: publisher, vmss_name, name, resource_group, settings, type, state, location, protected_settings, type_handler_version, auto_upgrade_minor_version

Create, update and delete Azure Virtual Machine Scale Set (VMSS) extensions.

Get Azure Virtual Machine Scale Set Extension facts

Arguments: vmss_name, name, resource_group

Get facts of Azure Virtual Machine Scale Set Extension.

Get Azure Virtual Machine Scale Set Instance facts

Arguments: instance_id, state, vmss_name, power_state, resource_group, latest_model

Get facts of Azure Virtual Machine Scale Set VMs.

Get Azure Virtual Machine Scale Set Instance facts

Arguments: instance_id, vmss_name, resource_group, tags

Get facts of Azure Virtual Machine Scale Set VMs.

Manage Azure virtual networks

Arguments: dns_servers, name, resource_group, state, address_prefixes_cidr, purge_address_prefixes, purge_dns_servers, location

Create, update or delete a virtual networks. Allows setting and updating the available IPv4 address ranges and setting custom DNS servers. Use the M(azure_rm_subnet) module to associate subnets with a virtual network.

Get virtual network facts

Arguments: name, resource_group, tags

Get facts for a specific virtual network or all virtual networks within a resource group.

Manage Azure virtual network gateways

Arguments: sku, name, resource_group, vpn_type, enable_bgp, bgp_settings, state, location, virtual_network, ip_configurations, gateway_type

Create, update or delete a virtual network gateway(VPN Gateway). When creating a VPN Gateway you must provide the name of an existing virtual network.

Manage Azure Virtual Network Peering

Arguments: name, resource_group, remote_virtual_network, state, allow_forwarded_traffic, virtual_network, use_remote_gateways, allow_virtual_network_access, allow_gateway_transit

Create, update and delete Azure Virtual Network Peering.

Get facts of Azure Virtual Network Peering

Arguments: virtual_network, name, resource_group

Get facts of Azure Virtual Network Peering.

Manage Web App instances

Arguments: resource_group, dns_registration, scm_type, app_settings, plan, https_only, deployment_source, app_state, name, purge_app_settings, skip_custom_domain_verification, frameworks, state, location, client_affinity_enabled, startup_file, ttl_in_seconds, container_settings

Create, update and delete instance of Web App.

Get Azure web app facts

Arguments: resource_group, name, return_publish_profile, tags

Get facts for a specific web app or all web app in a resource group, or all web app in current subscription.

Manage Azure Web App slot

Arguments: configuration_source, name, resource_group, purge_app_settings, app_state, frameworks, state, container_settings, app_settings, startup_file, auto_swap_slot_name, webapp_name, swap, deployment_source, location

Create, update and delete Azure Web App slot.

Create and remove a bcf switch.

Arguments: name, access_token, state, mac, controller, leaf_group, validate_certs, fabric_role

Create and remove a Big Cloud Fabric switch.

Manage ZFS boot environments on FreeBSD/Solaris/illumos systems.

Arguments: state, force, name, mountpoint, snapshot, options, description

Create, delete or activate ZFS boot environments. Mount and unmount ZFS boot environments.

Send BearyChat notifications

Arguments: url, text, markdown, attachments, channel

The M(bearychat) module sends notifications to U(https://bearychat.com) via the Incoming Robot integration.

Manage user-defined APM ACLs

Arguments: path_match_case, acl_order, partition, name, state, entries, type, description

Manage user-defined APM ACLs.

Manage APM Network Access resource

Arguments: dtls_port, allow_local_subnet, excluded_ipv6_adresses, ipv6_address_space, ip_version, excluded_ipv4_adresses, allow_local_dns, ipv4_address_space, dtls, split_tunnel, ipv4_lease_pool, name, description, partition, dns_address_space, state, ipv6_lease_pool, snat_pool, excluded_dns_addresses

Manage APM Network Access resource.

Exports the APM policy or APM access profile from remote nodes.

Arguments: force, name, file, dest, partition, type

Exports the apm policy or APM access profile from remote nodes.

Manage BIG-IP APM policy or APM access profile imports

Arguments: source, partition, force, name, type

Manage BIG-IP APM policy or APM access profile imports.

Manage application service deployments

Arguments: content, tenants, state, force

Manages application service deployments via the App Services Extension functionality in BIG-IP.

Manage application settings for DOS profile

Arguments: profile, geolocations, trigger_irule, heavy_urls, mobile_detection, partition, rtbh_enable, rtbh_duration, scrubbing_enable, state, scrubbing_duration, single_page_application

Manages Application settings for ASM/AFM DOS profile.

Exports the asm policy from remote nodes.

Arguments: compact, binary, base64, force, name, dest, partition, file, inline

Exports the asm policy from remote nodes.

Manage BIG-IP ASM policy imports

Arguments: inline, partition, force, name, source

Manage BIG-IP ASM policies policy imports.

Manage BIG-IP ASM policies

Arguments: active, state, partition, name, template

Manage BIG-IP ASM policies, create from templates and manage global policy settings.

Manages Server Technology on ASM policy

Arguments: state, partition, name, policy_name

Manages Server Technology on ASM policy.

Manages Signature Sets on ASM policy

Arguments: state, name, learn, alarm, partition, block, policy_name

Manages Signature Sets on ASM policy.

Manage CLI aliases on a BIG-IP

Arguments: state, command, name, scope, partition, description

Allows for managing both private and shared aliases on a BIG-IP.

Manage CLI scripts on a BIG-IP

Arguments: content, state, partition, name, description

Manages CLI scripts on a BIG-IP. CLI scripts, otherwise known as tmshell scripts or TMSH scripts allow you to create custom scripts that can run to manage objects within a BIG-IP.

Run TMSH and BASH commands on F5 devices

Arguments: retries, commands, chdir, interval, warn, transport, wait_for, match

Sends a TMSH or BASH command to an BIG-IP node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met. This module is B(not) idempotent, nor will it ever be. It is intended as a stop-gap measure to satisfy automation requirements until such a time as a real module has been developed to configure in the way you need. If you are using this module, you should probably also be filing an issue to have a B(real) module created for your needs.

Manage BIG-IP configuration sections

Arguments: reset, verify, save, merge_content

Manages a BIG-IP configuration by allowing TMSH commands that modify running configuration, or merge SCF formatted files into the running configuration. Additionally, this module is of significant importance because it allows you to save your running configuration to disk. Since the F5 module only manipulate running configuration, it is important that you utilize this module to save that running config.

Perform different actions related to config-sync

Arguments: overwrite_config, sync_device_to_group, device_group, sync_most_recent_to_device

Allows one to run different config-sync actions. These actions allow you to manually sync your configuration across multiple BIG-IPs when those devices are in an HA pair.

Manage data groups on a BIG-IP

Arguments: name, delete_data_group_file, partition, records_src, records, state, internal, separator, external_file_name, type, description

Allows for managing data groups on a BIG-IP. Data groups provide a way to store collections of values on a BIG-IP for later use in things such as LTM rules, iRules, and ASM policies.

Manage system authentication on a BIG-IP

Arguments: protocol_name, service_name, secret, state, authentication, use_for_auth, update_secret, servers, type

Manage the system authentication configuration. This module can assist in configuring a number of different system authentication types. Note that this module can not be used to configure APM authentication types.

Manage LDAP device authentication settings on BIG-IP

Arguments: update_password, remote_directory_tree, login_ldap_attr, servers, ssl, port, client_key, ca_cert, user_template, check_member_attr, bind_dn, fallback_to_local, state, bind_password, scope, validate_certs, client_cert

Manage LDAP device authentication settings on BIG-IP.

Manage self-signed device certificates

Arguments: force, key_name, days_valid, key_size, cert_name, add_to_trusted, new_cert, transport, issuer

Module used to create and/or renew self-signed device certificates for BIG-IP.

Manages device IP configuration settings for HA on a BIG-IP

Arguments: multicast_interface, mirror_primary_address, failover_multicast, config_sync_ip, mirror_secondary_address, multicast_address, unicast_failover, cluster_mirroring, multicast_port

Manages device IP configuration settings for HA on a BIG-IP. Each BIG-IP device has synchronization and failover connectivity information (IP addresses) that you define as part of HA pairing or clustering. This module allows you to configure that information.

Manage BIG-IP device DNS settings

Arguments: name_servers, ip_version, search, cache, state

Manage BIG-IP device DNS settings.

Manage device groups on a BIG-IP

Arguments: name, auto_sync, description, max_incremental_sync_size, save_on_auto_sync, state, full_sync, type, network_failover

Managing device groups allows you to create HA pairs and clusters of BIG-IP devices. Usage of this module should be done in conjunction with the C(bigip_configsync_actions) to sync configuration across the pair or cluster if auto-sync is disabled.

Manages members in a device group

Arguments: state, name, device_group

Manages members in a device group. Members in a device group can only be added or removed, never updated. This is because the members are identified by unique name values and changing that name would invalidate the uniqueness.

Manage HA group settings on a BIG-IP system

Arguments: state, enable, trunks, name, pools, active_bonus, description

Manage HA group settings on a BIG-IP system.

Manage HTTPD related settings on BIG-IP

Arguments: auth_pam_validate_ip, hostname_lookup, log_level, redirect_http_to_https, auth_pam_dashboard_timeout, ssl_protocols, fast_cgi_timeout, allow, ssl_port, auth_pam_idle_timeout, max_clients, ssl_cipher_suite, auth_name

Manages HTTPD related settings on the BIG-IP. These settings are interesting to change when you want to set GUI timeouts and other TMUI related settings.

Collect information from F5 BIG-IP devices

Arguments: gather_subset

Collect information from F5 BIG-IP devices. This module was called C(bigip_device_facts) before Ansible 2.9. The usage did not change.

Manage license installation and activation on BIG-IP devices

Arguments: license_key, license_server, accept_eula, state

Manage license installation and activation on a BIG-IP.

Manage NTP servers on a BIG-IP

Arguments: ntp_servers, timezone, state

Manage NTP servers on a BIG-IP.

Manage the SSHD settings of a BIG-IP

Arguments: log_level, allow, banner_text, inactivity_timeout, login, banner, port

Manage the SSHD settings of a BIG-IP.

Manage system-level syslog settings on BIG-IP

Arguments: local6_from, mail_from, mail_to, local6_to, auth_priv_from, user_log_from, kern_from, messages_to, kern_to, daemon_from, daemon_to, auth_priv_to, console_log, messages_from, cron_from, iso_date, user_log_to, include, cron_to

Manage system-level syslog settings on BIG-IP.

Manages traffic groups on BIG-IP

Arguments: ha_order, name, auto_failback_time, partition, ha_group, auto_failback, state, ha_load_factor, mac_address

Supports managing traffic groups and their attributes on a BIG-IP.

Manage the trust relationships between BIG-IPs

Arguments: state, peer_user, peer_server, peer_password, type, peer_hostname

Manage the trust relationships between BIG-IPs. Devices, once peered, cannot be updated. If updating is needed, the peer must first be removed before it can be re-added to the trust.

Manage DNS resolver cache configurations on BIG-IP

Arguments: answer_default_zones, state, name, forward_zones, partition, route_domain

Manage DNS resolver cache configurations on BIG-IP.

Manage LTM DNS nameservers on a BIG-IP

Arguments: route_domain, tsig_key, name, address, service_port, partition, state

Manages LTM DNS nameservers on a BIG-IP. These nameservers form part of what is known as DNS Express on a BIG-IP. This module does not configure GTM related functionality, nor does it configure system-level name servers that affect the base system's ability to resolve DNS names.

Manage DNS resolvers on a BIG-IP

Arguments: use_udp, randomize_query_case, name, partition, route_domain, answer_default_zones, state, use_ipv4, use_ipv6, cache_size, use_tcp

Manage DNS resolver on a BIG-IP.

Manage DNS zones on BIG-IP

Arguments: tsig_server_key, state, name, dns_express, nameservers, partition

Manage DNS zones on BIG-IP. The zones managed here are primarily used for configuring DNS Express on BIG-IP. This module does not configure zones that are found in BIG-IP ZoneRunner.

Manage files in datastores on a BIG-IP

Arguments: source, state, force, name, datastore, partition

Manages files on a variety of datastores on a BIG-IP.

Manage address lists on BIG-IP AFM

Arguments: geo_locations, addresses, name, address_ranges, address_lists, fqdns, partition, state, description

Manages the AFM address lists on a BIG-IP. This module can be used to add and remove address list entries.

Manage AFM DoS profiles on a BIG-IP

Arguments: default_whitelist, state, name, threshold_sensitivity, partition, description

Manages AFM Denial of Service (DoS) profiles on a BIG-IP. To manage the vectors associated with a DoS profile, refer to the C(bigip_firewall_dos_vector) module.

Manage attack vector configuration in an AFM DoS profile

Arguments: profile, bad_actor_detection, blacklist_detection_seconds, per_source_ip_mitigation_threshold, threshold_mode, mitigation_threshold_eps, attack_floor, simulate_auto_threshold, name, attack_ceiling, partition, per_source_ip_detection_threshold, allow_advertisement, auto_blacklist, detection_threshold_percent, state, detection_threshold_eps, blacklist_duration

Manage attack vector configuration in an AFM DoS profile. In addition to the normal AFM DoS profile vectors, this module can manage the device-configuration vectors. See the module documentation for details about this method.

Manage AFM global rule settings on BIG-IP

Arguments: enforced_policy, staged_policy, service_policy, description

Configures the global network firewall rules. These firewall rules are applied to all packets except those going through the management interface. They are applied first, before any firewall rules for the packet's virtual server, route domain, and/or self IP.

Manages AFM logging profiles configured in the system

Arguments: port_misuse, dos_protection, name, partition, ip_intelligence, state, description

Manages AFM logging profiles configured in the system along with basic information about each profile.

Configures Network Firewall related settings of the log profile

Arguments: log_tcp_events, log_storage_format, log_tcp_errors, log_matches_drop_rule, log_ip_errors, log_translation_fields, partition, rate_limit, log_format_delimiter, state, profile_name, log_message_fields, log_matches_reject_rule, log_publisher, log_matches_accept_rule

Configures Network Firewall related settings of the log profile.

Manage AFM security firewall policies on a BIG-IP

Arguments: rules, state, partition, name, description

Manages AFM security firewall policies on a BIG-IP.

Manage port lists on BIG-IP AFM

Arguments: state, name, port_ranges, description, partition, port_lists, ports

Manages the AFM port lists on a BIG-IP. This module can be used to add and remove port list entries.

Manage AFM Firewall rules

Arguments: status, rule_list, destination, protocol, description, schedule, irule, icmp_message, parent_policy, logging, name, partition, source, state, action, parent_rule_list

Manages firewall rules in an AFM firewall policy. New rules will always be added to the end of the policy. Rules can be re-ordered using the C(bigip_security_policy) module. Rules can also be pre-ordered using the C(bigip_security_policy) module and then later updated using the C(bigip_firewall_rule) module.

Manage AFM security firewall policies on a BIG-IP

Arguments: rules, state, partition, name, description

Manages AFM security firewall policies on a BIG-IP.

Manage BIG-IP AFM schedule configurations

Arguments: days_of_week, daily_hour_start, partition, date_valid_start, name, daily_hour_end, state, date_valid_end, description

Manage BIG-IP AFM schedule configurations.

Manage Datacenter configuration in BIG-IP

Arguments: state, contact, description, name, partition, location

Manage BIG-IP data center configuration. A data center defines the location where the physical network components reside, such as the server and link objects that share the same subnet on the network. This module is able to manipulate the data center definitions in a BIG-IP.

Manages global GTM settings

Arguments: synchronization_group_name, synchronize_zone_files, synchronization

Manages global GTM settings. These settings include general, load balancing, and metrics related settings.

Manages F5 BIG-IP GTM BIG-IP monitors

Arguments: interval, name, parent, ip, partition, aggregate_dynamic_ratios, state, ignore_down_response, timeout, port

Manages F5 BIG-IP GTM BIG-IP monitors. This monitor is used by GTM to monitor BIG-IPs themselves.

Manages external GTM monitors on a BIG-IP

Arguments: interval, name, parent, ip, variables, partition, state, arguments, timeout, external_program, port

Manages external GTM monitors on a BIG-IP.

Manages F5 BIG-IP GTM FirePass monitors

Arguments: update_password, interval, parent, ip, cipher_list, concurrency_limit, target_username, max_load_average, name, partition, port, state, ignore_down_response, timeout, target_password, probe_timeout

Manages F5 BIG-IP GTM FirePass monitors.

Manages F5 BIG-IP GTM http monitors

Arguments: update_password, interval, parent, ip, transparent, reverse, name, receive, partition, send, target_username, port, state, ignore_down_response, timeout, target_password, probe_timeout

Manages F5 BIG-IP GTM http monitors.

Manages F5 BIG-IP GTM https monitors

Arguments: update_password, interval, parent, ip, port, cipher_list, compatibility, client_key, reverse, name, receive, partition, send, transparent, target_username, state, ignore_down_response, timeout, target_password, probe_timeout, client_cert

Manages F5 BIG-IP GTM https monitors.

Manages F5 BIG-IP GTM tcp monitors

Arguments: interval, name, parent, receive, ip, partition, send, port, state, ignore_down_response, timeout, probe_timeout, transparent, reverse

Manages F5 BIG-IP GTM tcp monitors.

Manages F5 BIG-IP GTM tcp half-open monitors

Arguments: probe_attempts, interval, name, parent, ip, partition, port, state, probe_interval, ignore_down_response, timeout, probe_timeout, transparent

Manages F5 BIG-IP GTM tcp half-open monitors.

Manages F5 BIG-IP GTM pools

Arguments: max_answers_returned, alternate_lb_method, name, partition, fallback_ip, preferred_lb_method, state, fallback_lb_method, availability_requirements, members, ttl, type, monitors

Manages F5 BIG-IP GTM pools.

Manage GTM pool member settings

Arguments: partition, ratio, monitor, limits, replace_all_with, server_name, member_order, state, aggregate, virtual_server, type, pool, description

Manages a variety of settings on GTM pool members. The settings that can be adjusted with this module are much more broad that what can be done in the C(bigip_gtm_pool) module. The pool module is intended to allow you to adjust the member order in the pool, not the various settings of the members. The C(bigip_gtm_pool_member) module should be used to adjust all of the other settings.

Manages F5 BIG-IP GTM servers

Arguments: link_discovery, name, limits, datacenter, partition, server_type, monitors, state, prober_preference, prober_fallback, virtual_server_discovery, prober_pool, devices, iquery_options, availability_requirements

Manage BIG-IP server configuration. This module is able to manipulate the server definitions in a BIG-IP.

Manages GTM Topology Records

Arguments: source, state, destination, weight, partition

Manages GTM Topology Records. Once created, only topology record C(weight) can be modified.

Manages GTM Topology Regions

Arguments: region_members, partition, name, state

Manages GTM Topology Regions.

Manages F5 BIG-IP GTM virtual servers

Arguments: partition, virtual_server_dependencies, translation_port, limits, server_name, translation_address, port, state, link, availability_requirements, address, monitors, name

Manages F5 BIG-IP GTM virtual servers. A GTM server can have many virtual servers associated with it. They are arranged in much the same way that pool members are to pools.

Manages F5 BIG-IP GTM wide ip

Arguments: name, pool_lb_method, partition, last_resort_pool, irules, state, pools, type, aliases

Manages F5 BIG-IP GTM wide ip.

Manage the hostname of a BIG-IP

Arguments: hostname

Manage the hostname of a BIG-IP.

Manages TCL iApp services on a BIG-IP

Arguments: force, description, parameters, strict_updates, partition, device_group, state, template, traffic_group, metadata, name

Manages TCL iApp services on a BIG-IP. If you are looking for the API that is communicated with on the BIG-IP, the one the is used is C(/mgmt/tm/sys/application/service/).

Manages TCL iApp templates on a BIG-IP

Arguments: content, state, partition, force, name

Manages TCL iApp templates on a BIG-IP. This module will allow you to deploy iApp templates to the BIG-IP and manage their lifecycle. The conventional way to use this module is to import new iApps as needed or by extracting the contents of the iApp archive that is provided at downloads.f5.com and then importing all the iApps with this module. This module can also update existing iApps provided that the source of the iApp changed while the name stayed the same. Note however that this module will not reconfigure any services that may have been created using the C(bigip_iapp_service) module. iApps are normally not updated in production. Instead, new versions are deployed and then existing services are changed to consume that new template. As such, the ability to update templates in-place requires the C(force) option to be used.

Manage IPSec IKE Peer configuration on BIG-IP

Arguments: phase1_verify_peer_cert, update_password, verified_id_type, presented_id_type, description, remote_address, phase1_auth_method, phase1_key, phase1_hash_algorithm, phase1_cert, verified_id_value, name, presented_id_value, preshared_key, partition, phase1_perfect_forward_secrecy, state, version, phase1_encryption_algorithm

Manage IPSec IKE Peer configuration on BIG-IP.

Manage BIG-IP advanced routing configuration sections

Arguments: src, backup_options, after, lines, intended_config, diff_against, route_domain, parents, save_when, before, running_config, replace, backup, match, diff_ignore_lines

This module provides an implementation for working with advanced routing configuration sections in a deterministic way.

Manage IPSec policies on a BIG-IP

Arguments: ipv4_interface, protocol, description, auth_algorithm, route_domain, perfect_forward_secrecy, encrypt_algorithm, lifetime, name, partition, tunnel_local_address, kb_lifetime, state, ipcomp, mode, tunnel_remote_address

Manage IPSec policies on a BIG-IP.

Manage iRules across different modules on a BIG-IP

Arguments: content, src, state, name, partition, module

Manage iRules across different modules on a BIG-IP.

Manages log destinations on a BIG-IP.

Arguments: protocol, description, pool_settings, transport_profile, syslog_format, forward_to, address, server_ssl_profile, port, pool, name, syslog_settings, partition, template_delete_delay, state, distribution, type, template_retransmit_interval

Manages log destinations on a BIG-IP.

Manages log publishers on a BIG-IP

Arguments: description, state, partition, name, destinations

Manages log publishers on a BIG-IP.

Manages Javascript LX packages on a BIG-IP

Arguments: state, package

Manages Javascript LX packages on a BIG-IP. This module will allow you to deploy LX packages to the BIG-IP and manage their lifecycle.

Manage system management routes on a BIG-IP

Arguments: state, network, name, partition, gateway, description

Configures route settings for the management interface of a BIG-IP.

Manage peers for routing generic message protocol messages

Arguments: ratio, name, connection_mode, partition, auto_init_interval, state, auto_init, transport_config, number_of_connections, type, pool, description

Manage peers for routing generic message protocol messages.

Manage generic message parser profile.

Arguments: name, parent, max_msg_size, partition, max_egress_buffer, no_response, state, msg_terminator, disable_parser, description

Manages generic message parser profile for use with the message routing framework.

Manages static routes for routing message protocol messages

Arguments: peer_selection_mode, peers, name, src_address, partition, dst_address, state, type, description

Manages static routes for routing message protocol messages.

Manages router profiles for message-routing protocols

Arguments: ignore_client_port, description, parent, max_pending_messages, max_retries, mirrored_msg_sweeper_interval, mirror, name, inherited_traffic_group, type, partition, state, max_pending_bytes, routes, traffic_group, use_local_connection

Manages router profiles for message-routing protocols.

Manages configuration for an outgoing connection

Arguments: src_port, name, rules, partition, profiles, state, src_addr_translation, type, description

Manages configuration for an outgoing connection in BIG-IP message routing.

Manage DNS monitors on a BIG-IP

Arguments: accept_rcode, interval, description, parent, ip, allowed_divergence_value, answer_section_contains, up_interval, port, reverse, sampling_timespan, name, receive, partition, adaptive_limit, allowed_divergence_type, state, time_until_up, query_name, manual_resume, timeout, query_type, adaptive, transparent

Manages DNS monitors on a BIG-IP.

Manages external LTM monitors on a BIG-IP

Arguments: interval, name, parent, ip, variables, partition, state, arguments, timeout, external_program, port, description

Manages external LTM monitors on a BIG-IP.

Manages F5 BIG-IP LTM gateway ICMP monitors

Arguments: interval, description, parent, ip, up_interval, port, sampling_timespan, name, time_until_up, partition, adaptive_limit, allowed_divergence_type, state, allowed_divergence_value, manual_resume, timeout, adaptive, transparent

Manages gateway ICMP monitors on a BIG-IP.

Manages F5 BIG-IP LTM http monitors

Arguments: interval, description, parent, ip, target_username, receive_disable, reverse, receive, name, partition, send, port, state, time_until_up, timeout, target_password

Manages F5 BIG-IP LTM http monitors.

Manages F5 BIG-IP LTM https monitors

Arguments: interval, description, parent, ssl_profile, ip, up_interval, target_username, name, receive_disable, receive, partition, send, port, state, time_until_up, timeout, target_password

Manages F5 BIG-IP LTM https monitors.

Manages BIG-IP LDAP monitors

Arguments: update_password, interval, description, parent, ip, chase_referrals, mandatory_attributes, base, up_interval, target_username, name, partition, port, filter, state, time_until_up, manual_resume, timeout, debug, target_password, security

Manages BIG-IP LDAP monitors.

Manages BIG-IP SNMP data collecting agent (DCA) monitors

Arguments: interval, disk_threshold, parent, community, cpu_threshold, description, name, cpu_coefficient, time_until_up, partition, memory_threshold, disk_coefficient, state, version, agent_type, memory_coefficient, timeout

The BIG-IP has an SNMP data collecting agent (DCA) that can query remote SNMP agents of various types, including the UC Davis agent (UCD) and the Windows 2000 Server agent (WIN2000).

Manages F5 BIG-IP LTM tcp monitors

Arguments: interval, name, parent, receive, ip, partition, send, state, time_until_up, timeout, port, description

Manages F5 BIG-IP LTM tcp monitors via iControl SOAP API.

Manages F5 BIG-IP LTM tcp echo monitors

Arguments: interval, name, parent, ip, partition, state, time_until_up, timeout, description

Manages F5 BIG-IP LTM tcp echo monitors.

Manages F5 BIG-IP LTM tcp half-open monitors

Arguments: interval, name, parent, ip, partition, state, time_until_up, timeout, port, description

Manages F5 BIG-IP LTM tcp half-open monitors.

Manages F5 BIG-IP LTM udp monitors

Arguments: interval, receive_disable, parent, receive, ip, partition, send, name, state, time_until_up, timeout, port, description

Manages F5 BIG-IP LTM udp monitors.

Manages F5 BIG-IP LTM nodes

Arguments: description, fqdn_auto_populate, rate_limit, fqdn_up_interval, address, monitors, name, ratio, quorum, fqdn_address_type, partition, connection_limit, fqdn, monitor_type, state, availability_requirements, fqdn_down_interval, dynamic_ratio

Manages F5 BIG-IP LTM nodes.

Manage BIG-IP partitions

Arguments: route_domain, description, state, name

Manage BIG-IP partitions.

Manages the authentication password policy on a BIG-IP

Arguments: password_memory, max_duration, required_special, required_uppercase, min_length, max_login_failures, min_duration, required_lowercase, policy_enforcement, expiration_warning, required_numeric

Manages the authentication password policy on a BIG-IP.

Manage general policy configuration on a BIG-IP

Arguments: state, description, name, rules, partition, strategy

Manages general policy configuration on a BIG-IP. This module is best used in conjunction with the C(bigip_policy_rule) module. This module can handle general configuration like setting the draft state of the policy, the description, and things unrelated to the policy rules themselves. It is also the first module that should be used when creating rules as the C(bigip_policy_rule) module requires a policy parameter.

Manage LTM policy rules on a BIG-IP

Arguments: state, description, policy, partition, conditions, actions, name

This module will manage LTM policy rules on a BIG-IP.

Manages F5 BIG-IP LTM pools

Arguments: monitors, lb_method, quorum, replace_all_with, priority_group_activation, partition, slow_ramp_time, service_down_action, reselect_tries, state, description, aggregate, metadata, monitor_type, name

Manages F5 BIG-IP LTM pools via iControl REST API.

Manages F5 BIG-IP LTM pool members

Arguments: description, replace_all_with, fqdn_auto_populate, connection_limit, ip_encapsulation, preserve_node, address, aggregate, monitors, pool, ratio, name, partition, rate_limit, fqdn, reuse_nodes, port, state, availability_requirements, priority_group

Manages F5 BIG-IP LTM pool members via iControl SOAP API.

Manage HTTP analytics profiles on a BIG-IP

Arguments: partition, description, parent, notification_by_email, external_logging_publisher, collect_max_tps_and_throughput, collected_stats_external_logging, name, collect_ip, collect_geo, collect_user_sessions, notification_by_syslog, collect_page_load_time, state, collected_stats_internal_logging, collect_url, collect_user_agent, notification_email_addresses

Manage HTTP analytics profiles on a BIG-IP.

Manages client SSL profiles on a BIG-IP

Arguments: ciphers, allow_non_ssl, cert_key_chain, sni_require, client_auth_frequency, cert_auth_depth, client_auth_crl, allow_expired_crl, retain_certificate, advertised_cert_authority, strict_resume, name, parent, server_name, secure_renegotiation, partition, options, state, renegotiation, sni_default, trusted_cert_authority, client_certificate

Manages client SSL profiles on a BIG-IP.

Manage DNS profiles on a BIG-IP

Arguments: enable_dns_firewall, enable_zone_transfer, name, parent, process_recursion_desired, unhandled_query_action, enable_cache, enable_dns_express, partition, state, use_local_bind, enable_gtm, enable_dnssec, cache_name

Manage DNS profiles on a BIG-IP. Many DNS profiles; each with their own adjustments to the standard C(dns) profile. Users of this module should be aware that many of the adjustable knobs have no module default. Instead, the default is assigned by the BIG-IP system itself which, in most cases, is acceptable.

Manages Fast L4 profiles

Arguments: ip_df_mode, receive_window_size, tcp_handshake_timeout, ip_tos_to_client, tcp_timestamp_mode, late_binding, mss_override, tcp_close_timeout, server_timestamp, link_qos_to_server, state, tcp_time_wait_timeout, tcp_strip_sack, reassemble_fragments, ip_ttl_mode, ip_ttl_v6, ip_ttl_v4, loose_initialization, keep_alive_interval, description, parent, idle_timeout, timeout_recovery, name, server_sack, reset_on_timeout, partition, tcp_wscale_mode, rtt_from_client, rtt_from_server, explicit_flow_migration, ip_tos_to_server, link_qos_to_client, client_timeout, loose_close, tcp_generate_isn, syn_cookie_mss

Manages Fast L4 profiles.

Manage HTTP profiles on a BIG-IP

Arguments: enforcement, update_password, request_chunking, description, parent, insert_xforwarded_for, header_insert, fallback_host, maximum_age, accept_xff, dns_resolver, hsts_mode, encrypt_cookies, fallback_status_codes, server_agent_name, sflow, name, encrypt_cookie_secret, xff_alternative_names, partition, response_chunking, state, oneconnect_transformations, redirect_rewrite, header_erase, include_subdomains, proxy_type

Manage HTTP profiles on a BIG-IP.

Manage HTTP compression profiles on a BIG-IP

Arguments: name, parent, partition, gzip_window_size, state, gzip_memory_level, buffer_size, gzip_level, description

Manage HTTP compression profiles on a BIG-IP.

Manage HTTP2 profiles on a BIG-IP

Arguments: receive_window, insert_header_name, name, parent, activation_modes, partition, idle_timeout, write_size, state, enforce_tls_requirements, streams, frame_size, insert_header, header_table_size, description

Manage HTTP2 profiles on a BIG-IP.

Manage OneConnect profiles on a BIG-IP

Arguments: idle_timeout_override, source_mask, name, parent, maximum_reuse, partition, maximum_age, limit_type, state, maximum_size, share_pools, description

Manage OneConnect profiles on a BIG-IP.

Manage cookie persistence profiles on BIG-IP

Arguments: update_password, secure, parent, cookie_name, cookie_encryption, encrypt_cookie_pool_name, match_across_virtuals, always_send, cookie_method, name, match_across_pools, description, partition, match_across_services, state, expiration, override_connection_limit, http_only, encryption_passphrase

Manage cookie persistence profiles on BIG-IP.

Manage source address persistence profiles

Arguments: name, parent, match_across_pools, entry_timeout, partition, match_across_services, state, match_across_virtuals, hash_algorithm, override_connection_limit

Manages source address persistence profiles.

Manages server SSL profiles on a BIG-IP

Arguments: update_password, ciphers, passphrase, parent, sni_require, server_certificate, key, name, server_name, secure_renegotiation, partition, ocsp_profile, state, certificate, chain, sni_default

Manages server SSL profiles on a BIG-IP.

Manage TCP profiles on a BIG-IP

Arguments: name, parent, initial_congestion_window_size, partition, proxy_options, syn_rto_base, idle_timeout, state, initial_receive_window_size, time_wait_recycle, nagle, early_retransmit

Manage TCP profiles on a BIG-IP. Many TCP profiles; each with their own adjustments to the standard C(tcp) profile. Users of this module should be aware that many of the adjustable knobs have no module default. Instead, the default is assigned by the BIG-IP system itself which, in most cases, is acceptable.

Manage UDP profiles on a BIG-IP

Arguments: idle_timeout, datagram_load_balancing, name, parent, partition, state

Manage UDP profiles on a BIG-IP. Many of UDP profiles exist; each with their own adjustments to the standard C(udp) profile. Users of this module should be aware that many of the adjustable knobs have no module default. Instead, the default is assigned by the BIG-IP system itself which, in most cases, is acceptable.

Manage BIG-IP module provisioning

Arguments: state, level, module, memory

Manage BIG-IP module provisioning. This module will only provision at the standard levels of Dedicated, Nominal, and Minimum.

Manage qkviews on the device

Arguments: max_file_size, force, asm_request_log, dest, filename, exclude_core, complete_information, exclude

Manages creating and downloading qkviews from a BIG-IP. Various options can be provided when creating qkviews. The qkview is important when dealing with F5 support. It may be required that you upload this qkview to the supported channels during resolution of an SRs that you may have opened.

Manage remote roles on a BIG-IP

Arguments: attribute_string, line_order, name, terminal_access, partition_access, state, remote_access, assigned_role

Manages remote roles on a BIG-IP. Remote roles are used in situations where user authentication is handled off-box. Local access control to the BIG-IP is controlled by the defined remote role. Where-as authentication (and by extension, assignment to the role) is handled off-box.

Manipulate remote syslog settings on a BIG-IP

Arguments: state, remote_port, remote_host, name, local_ip

Manipulate remote syslog settings on a BIG-IP.

Manages default settings for remote user accounts on a BIG-IP

Arguments: console_access, default_partition, default_role, description

Manages default settings for remote user accounts on a BIG-IP.

Manage route domains on a BIG-IP

Arguments: flow_eviction_policy, service_policy, description, parent, partition, connection_limit, name, strict, state, routing_protocol, bwc_policy, vlans, id, fw_enforced_policy

Manage route domains on a BIG-IP.